optimize build file for smaller apks
[headphoneindicator.git] / README.rst
index 7f775b4ad7bab0f682d781ca4cb4c1d71090af6c..5f55d6af9c165c182747373c606a0b7d17f5f3cb 100644 (file)
@@ -9,6 +9,31 @@ 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?
+===================
+I wrote the headphone indicator app because I was immensely unsatisfied
+with apps like `susomena's Headphones Indicator`__ which are over
+2 MiB in size, but 99% of their code is only related to advertisement.
+
+My task was to show that you can make it much, much better.
+
+__ https://play.google.com/store/apps/details?id=com.susomena.headphonesindicator
+
+
 ========
 Building
 ========