X-Git-Url: https://git.cweiske.de/headphoneindicator.git/blobdiff_plain/b5255cb64fd98c0ac44307910de0783f1e76f7f7..1f3b856d4d6e3814dfc1655c53ef8d348fca9687:/README.rst

diff --git a/README.rst b/README.rst
index 06b9d50..f6d6cea 100644
--- a/README.rst
+++ b/README.rst
@@ -9,6 +9,19 @@ The app aims to be a tiny as possible.
 Runs on Android 4.4+.
 
 
+=====
+Usage
+=====
+After installation, you have to start the application `at least once`__.
+Then it will be running as a background service that shows the headset
+status icon whenever the headphones are plugged in.
+
+You can close the app, and the status icon will still work - even after
+rebooting your phone.
+
+__ http://stackoverflow.com/a/8535062/282601
+
+
 ===================
 Why was it written?
 ===================
@@ -28,6 +41,28 @@ Building
 
     $ ./gradlew build
 
+Note that AndroidStudio 1.5.1 does not detect the gradle configuration correctly
+and produces ``.apk`` files much larger than necessary, with duplicated files.
+
+``gradlew`` on command line does it correctly, though.
+
+
+Releasing
+=========
+Build it normally, then sign the generated package file::
+
+    $ ./gradlew assembleRelease
+
+To sign the release with your key, put the path to the signing configuration
+file into ``gradle.properties``::
+
+    signingconfigfile=/path/to/signing-config.gradle
+
+The signing configuration file should look like shown in
+`Handling signing configs with Gradle`__
+
+__ https://www.timroes.de/2013/09/22/handling-signing-configs-with-gradle/
+
 
 =========================
 About headphone indicator