From 5699bb3e9af529b3532336c2fb474305f12e474a Mon Sep 17 00:00:00 2001
From: 9and3r <9and3r@gmail.com>
Date: Mon, 4 Aug 2014 15:05:50 +0200
Subject: [PATCH] Documentation updated

---
 docs/index.rst | 131 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 117 insertions(+), 14 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index bbef51e..92df9a9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,22 +1,125 @@
-.. Mopidy-Touchscreen documentation master file, created by
-   sphinx-quickstart on Mon Aug  4 00:48:14 2014.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+****************************
+Mopidy-Touchscreen
+****************************
 
-Welcome to Mopidy-Touchscreen's documentation!
-==============================================
+.. image:: https://img.shields.io/pypi/v/Mopidy-Touchscreen.svg?style=flat
+    :target: https://pypi.python.org/pypi/Mopidy-Touchscreen/
+    :alt: Latest PyPI version
 
-Contents:
+.. image:: https://img.shields.io/pypi/dm/Mopidy-Touchscreen.svg?style=flat
+    :target: https://pypi.python.org/pypi/Mopidy-Touchscreen/
+    :alt: Number of PyPI downloads
 
-.. toctree::
-   :maxdepth: 2
+.. image:: https://img.shields.io/travis/9and3r/mopidy-touchscreen/master.png?style=flat
+    :target: https://travis-ci.org/9and3r/mopidy-touchscreen
+    :alt: Travis CI build status
+
+.. image:: https://img.shields.io/coveralls/9and3r/mopidy-touchscreen/master.svg?style=flat
+   :target: https://coveralls.io/r/9and3r/mopidy-touchscreen?branch=master
+   :alt: Test coverage
+
+Extension for displaying track info and controlling Mopidy from a touch screen using `PyGame <http://www.pygame.org/>`_/SDL.
+
+Cover images are downloaded from `last.fm <http://www.last.fm/api>`_
+
+Dependencies
+============
+
+- ``Mopidy`` >= 0.18
+- ``Pykka`` >= 1.1
+- ``pygame``
+
+Installation
+============
+
+Install by running::
+
+    pip install Mopidy-Touchscreen
+
+Or, if available, install the Debian/Ubuntu package from `apt.mopidy.com
+<http://apt.mopidy.com/>`_.
 
 
+Configuration
+=============
 
-Indices and tables
-==================
+Before starting Mopidy, you must add configuration for
+Mopidy-Touchscreen to your Mopidy configuration file::
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    [touchscreen]
+    enabled = true
+    screen_width = 320
+    screen_height = 240
+    cursor = True
+    fullscreen = False
+    cache_dir = $XDG_CACHE_DIR/mopidy/touchscreen
 
+The following configuration values are available:
+    
+- ``touchscreen/enabled``: If the Touchscreen extension should be enabled or not.
+- ``touchscreen/screen_width``: The width of the resolution you want to use in pixels.
+- ``touchscreen/screen_height``: The width of the resolution you want to use in pixels.
+- ``touchscreen/cursor``: If the mouse cursor should be shown. (If you use a touchscreen it should be false)
+- ``touchscreen/fullscreen``: If you want to be shown as a window or in fullscreen.
+- ``touchscreen/screen_width``: The folder to be used as cache. Defaults to ``$XDG_CACHE_DIR/mopidy/touchscreen``, which usually means
+  ``~/.cache/mopidy/spotify``
+
+Features
+=============
+
+Working
+-------
+
+* See track info (track name, album, artist, cover image)
+* Seek Track
+* Play/Pause
+* Mute/Unmute
+* Change volume
+* Next/Previous track
+* Library
+* Menu (exit mopidy, restart...)
+* Shuffle on/off
+* Repeat one/on/off
+* Playback list and song selection
+* Playlists
+
+Planned
+-------
+
+* Use keyboard or GPIO buttons instead of touchscreen
+
+Screenshots
+===========
+
+.. image:: http://i60.tinypic.com/qqsait.jpg
+
+Video
+=====
+
+`Example video running the extension <https://www.youtube.com/watch?v=KuYoIb8Q2LI>`_
+
+Project resources
+=================
+
+- `Source code <https://github.com/9and3r/mopidy-touchscreen>`_
+- `Issue tracker <https://github.com/9and3r/mopidy-touchscreen/issues>`_
+- `Download development snapshot <https://github.com/9and3r/mopidy-touchscreen/archive/master.tar.gz#egg=Mopidy-Touchscreen-dev>`_
+
+
+Changelog
+=========
+
+v0.2.1
+----------------------------------------
+
+-Font will be included on instalation
+
+v0.2.0
+----------------------------------------
+
+- First working version
+
+v0.1.0 (UNRELEASED)
+----------------------------------------
+
+- Initial release.