aboutsummaryrefslogtreecommitdiff
path: root/libs/utils/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'libs/utils/README.md')
-rw-r--r--libs/utils/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/libs/utils/README.md b/libs/utils/README.md
new file mode 100644
index 000000000..e18da3d92
--- /dev/null
+++ b/libs/utils/README.md
@@ -0,0 +1,27 @@
+# WordPress-Utils-Android
+
+Collection of utility methods for Android and WordPress.
+
+## Use the library
+
+* In your build.gradle:
+```groovy
+dependencies {
+ // use the latest 1.x version
+ compile 'org.wordpress:utils:1.+'
+}
+```
+
+## Publish it to bintray
+
+```shell
+$ ./gradlew assemble publishToMavenLocal bintrayUpload -PbintrayUser=FIXME -PbintrayKey=FIXME -PdryRun=false
+```
+
+## Apps that use this library
+- [WordPress for Android][1]
+
+## License
+Dual licensed under MIT, and GPL.
+
+[1]: https://github.com/wordpress-mobile/WordPress-Android