add readme
authorChristian Weiske <cweiske@cweiske.de>
Wed, 23 Mar 2016 05:36:19 +0000 (06:36 +0100)
committerChristian Weiske <cweiske@cweiske.de>
Wed, 23 Mar 2016 05:36:19 +0000 (06:36 +0100)
README.rst [new file with mode: 0644]

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..7f775b4
--- /dev/null
@@ -0,0 +1,45 @@
+*******************
+Headphone indicator
+*******************
+Android app that shows a notification icon in the status bar when
+headphones are plugged into the phone.
+
+The app aims to be a tiny as possible.
+
+Runs on Android 4.4+.
+
+
+========
+Building
+========
+::
+
+    $ ./gradlew build
+
+
+=========================
+About headphone indicator
+=========================
+
+Source code
+===========
+Headphone indicators's source code is available from
+http://git.cweiske.de/headphoneindicator.git
+or the `mirror on github`__.
+
+__ https://github.com/cweiske/headphoneindicator
+
+
+License
+=======
+Headphone indicator is licensed under the `GPL v3 or later`__.
+
+__ http://www.gnu.org/licenses/gpl.html
+
+
+Author
+======
+Headphone indicator was written by `Christian Weiske`__.
+
+__ http://cweiske.de/
+