Update 'README.md'

README.md

@@ -1,3 +1,60 @@
-# python-for-android
+python-for-android
+==================
+
+[![Build Status](https://travis-ci.org/kivy/python-for-android.svg?branch=develop)](https://travis-ci.org/kivy/python-for-android)
+[![Coverage Status](https://coveralls.io/repos/github/kivy/python-for-android/badge.svg?branch=develop&kill_cache=1)](https://coveralls.io/github/kivy/python-for-android?branch=develop)
+[![Backers on Open Collective](https://opencollective.com/kivy/backers/badge.svg)](#backers)
+[![Sponsors on Open Collective](https://opencollective.com/kivy/sponsors/badge.svg)](#sponsors)
+
+python-for-android is a packaging tool for Python apps on Android. You can
+create your own Python distribution including the modules and
+dependencies you want, and bundle it in an APK along with your own code.
+
+Features include:
+
+-  Support for building with both Python 2 and Python 3.
+-  Different app backends including Kivy, PySDL2, and a WebView with
+   Python webserver.
+-  Automatic support for most pure Python modules, and built in support
+   for many others, including popular dependencies such as numpy and
+   sqlalchemy.
+-  Multiple architecture targets, for APKs optimised on any given
+   device.
+
+For documentation and support, see:
+
+-  Website: http://python-for-android.readthedocs.io
+-  Mailing list: https://groups.google.com/forum/#!forum/kivy-users or
+   https://groups.google.com/forum/#!forum/python-android.
+
+## Documentation
+
+Follow the [quickstart
+instructions](<https://python-for-android.readthedocs.org/en/latest/quickstart/>)
+to install and begin creating APKs.
+
+**Quick instructions**: install python-for-android with:
+
+    pip install python-for-android
+
+(for the develop branch: `pip install git+https://github.com/kivy/python-for-android.git`)
+
+Test that the install works with:
+
+    p4a --version
+
+To build any actual apps, **set up the Android SDK and NDK**
+as described in the [quickstart](
+<https://python-for-android.readthedocs.org/en/latest/quickstart/#installing-android-sdk>).
+**Use the SDK/NDK API level & NDK version as in the quickstart,**
+other API levels may not work.
+
+With everything installed, build an APK with SDL2 with e.g.:
+
+    p4a apk --requirements=kivy --private /home/username/devel/planewave_frozen/ --package=net.inclem.planewavessdl2 --name="planewavessdl2" --version=0.5 --bootstrap=sdl2
+
+**For full instructions and parameter options,** see [the
+documentation](https://python-for-android.readthedocs.io/en/latest/quickstart/#usage).
+
+
 
-python-for-android is a packaging tool for Python apps on Android. You can create your own Python distribution including the modules and dependencies you want, and bundle it in an APK along with your own code.