X-Git-Url: http://git.kaliko.me/?p=python-musicpd.git;a=blobdiff_plain;f=README.rst;h=45be05004e49d9e1c89b5fa4117a20df7c679830;hp=a926514908ef9fe257a906815416c673f3f870c1;hb=e616985e3da118a4e2b14afe331446633e7e2254;hpb=d28bd57ddc3465db4fcaa540fe7cb3de53f8be6b

diff --git a/README.rst b/README.rst
index a926514..45be050 100644
--- a/README.rst
+++ b/README.rst
@@ -1,77 +1,13 @@
-==============
-python-musicpd
-==============
+Python MusicPlayerDaemon client module
+***************************************
 
-Getting python-musicpd
-----------------------
+An MPD (Music Player Daemon) client library written in pure Python.
 
-The latest release of python-musicpd can be found at
-http://pypi.python.org/pypi/python-musicpd.
+----
 
-
-Getting the latest source code
-------------------------------
-
-If you would instead like to use the latest source code, you can grab a copy
-of the development version from git by running the command:
-
-  git clone git://git.kaliko.me/python-musicpd.git
-
-
-Installing from source
-----------------------
-
-To install python-musicpd from source, simply run the command::
-
-  python3 setup.py install
-
-You can use the `--help` switch to `setup.py` for a complete list of commands
-and their options.  See the `Installing Python Modules`_ document for more details.
-
-
-Using the client library
-------------------------
-
-The client library can be used as follows::
-
-    client = musicpd.MPDClient()       # create client object
-    client.connect('localhost', 6600)  # connect to localhost:6600
-    print client.mpd_version           # print the mpd version
-    print client.cmd('one', 2)         # print result of the command "cmd one 2"
-    client.close()                     # send the close command
-    client.disconnect()                # disconnect from the server
-
-A list of supported commands, their arguments (as MPD currently understands
-them), and the functions used to parse their responses can be found in
-`doc/commands.txt`.  See the `MPD protocol documentation`_ for more
-details.
-
-Command lists are also supported using `command_list_ok_begin()` and
-`command_list_end()` ::
-
-    client.command_list_ok_begin()       # start a command list
-    client.update()                      # insert the update command into the list
-    client.status()                      # insert the status command into the list
-    results = client.command_list_end()  # results will be a list with the results
-
-
-Commands may also return iterators instead of lists if `iterate` is set to
-`True`::
-
-    client.iterate = True
-    for song in client.playlistinfo():
-        print song['file']
-
-
-Contacting authors
-------------------
-
-You can contact the original author by emailing J. Alexander Treuman
-<jat⊘spatialrift.net>.  He can also be found idling in #mpd on
-irc.freenode.net as jat.
-
-The current maintainer can be found on xmpp chat room <kaliko.me⊘conf.azylum.org>
-or you can contact him by email/xmpp <kaliko⊘azylum.org>.
-
- .. _Installing Python Modules: http://docs.python.org/3/install/
- .. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/
+:Documentation: https://kaliko.gitlab.io/python-musicpd
+:MPD Protocol:  https://www.musicpd.org/doc/html/protocol.html
+:Code:          https://gitlab.com/kaliko/python-musicpd
+:Dependencies:  None
+:Compatibility: Python 3.4+
+:Licence:       GNU LGPLv3