Merge branch 'master' of https://github.com/techstar-cloud/circle-menu

README.md

@@ -1 +1,44 @@
-# circle-menu
+# Android Circle Menu
+
+CircleMenu is a simple, elegant UI menu with a circular layout and material design.
+
+How to include
+---
+
+With gradle: edit your `build.gradle`:
+```groovy
+allprojects {
+    repositories {
+        ...
+        maven { url "https://jitpack.io" }
+    }
+}
+
+dependencies {
+    compile 'com.github.techstar-cloud:circle-menu:v1.0.0'
+}
+```
+
+Or declare it into your `pom.xml`:
+
+```xml
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+
+<dependency>
+    <groupId>com.github.techstar-cloud</groupId>
+    <artifactId>circle-menu</artifactId>
+    <version>v1.0.0</version>
+</dependency>
+```
+
+How to use
+---
+
+#### Basic Usage
+
+   coming soon