Change README to Markdown.

This commit is contained in:
2013-10-27 17:18:42 +00:00
parent 453c1597ae
commit 9fd521336a

View File

@@ -1,24 +1,35 @@
----------
python-ts3
----------
python-ts3 is a abstraction library around the Teamspeak 3 ServerQuery API. It python-ts3
allows native access to the ServerQuery API with most of the formatting ==========
python-ts3 is a abstraction library around the Teamspeak 3 ServerQuery API. It
allows native access to the ServerQuery API with most of the formatting
headaches avoided. headaches avoided.
[![Build Status](https://travis-ci.org/nikdoof/python-ts3.png?branch=develop)](https://travis-ci.org/nikdoof/python-ts3)
Python Support
--------------
At the moment python-ts3 supports Python 2.6 and Python 2.7.
Python 3 support is on the todo list.
Install Install
======== -------
Download the most recent sourcecode and install it:: Download the most recent sourcecode and install it::
git clone git://github.com/nikdoof/python-ts3.git git clone git://github.com/nikdoof/python-ts3.git
cd python-ts3 cd python-ts3
python setup.py install # sudo this python setup.py install
A stable version of python-ts3 is available on PyPi. Active development is done in the `develop` branch with release version merged into `master`
Example Example Usage
======== -------------
Example showing how to create a channel and sub-channel for it using python-ts3 library:: Example showing how to create a channel and sub-channel for it using python-ts3 library::
@@ -30,7 +41,7 @@ Example showing how to create a channel and sub-channel for it using python-ts3
# choose virtual server # choose virtual server
server.use(1) server.use(1)
# create a channel # create a channel
response = server.send_command('channelcreate', keys={'channel_name': 'Just some channel'}) response = server.send_command('channelcreate', keys={'channel_name': 'Just some channel'})
# id of the newly created channel # id of the newly created channel