add readme

zhangchunyang · zhangchunyang · commit ab1220d708ca · 2018-08-14T18:04:30.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@
 .DS_Store
 /build
 /captures
+deploy.sh
diff --git a/.idea/dictionaries/zhangchunyang.xml b/.idea/dictionaries/zhangchunyang.xml
diff --git a/README.md b/README.md
@@ -1,21 +1,21 @@
 # OkayFace ![](https://travis-ci.org/BSlience/OkayFace.svg?branch=master)
-This is an open sdk for face things. <br>
-You can do something interesting by it. <br>
+This is an open sdk for face things.
+You can do something interesting by it. 
 Enjoy it!
 
 # Try it
-
+You can import it to Android Studio and run it on device.
 
 # Installation
-
-
+Add <code>compile 'com.face:sdk:0.0.1'</code> to build.gradle dependencies of your app.
+Inherit <code>FaceCameraActivity</code> or <code>FaceInterfaceActivity</code> by your need.
+You can also learn it from the app. I'll show you the code there.
+    
 # Description
 
-
-# Documentation
-
-
 # Performance
 
+# Roadmap
+[future feature and known issues](./roadmap.md)
 
 # Reference
diff --git a/deploy.sh b/deploy.sh
@@ -0,0 +1 @@
+./gradlew clean build bintrayUpload -PbintrayUser=bslience -PbintrayKey=f9123be83afc879730ef570ffdc7abdd9f3e3830 -PdryRun=false

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+./gradlew clean build bintrayUpload -PbintrayUser=bslience -PbintrayKey=f9123be83afc879730ef570ffdc7abdd9f3e3830 -PdryRun=false`