Added readme file

This commit is contained in:
Correl Roush 2010-06-22 12:28:49 -04:00
parent 9d02557eaa
commit 5cd563c170

21
README.md Normal file
View file

@ -0,0 +1,21 @@
Transmission-XBMC
=================
A client for the popular [Transmission](http://www.transmissionbt.com/) BitTorrent application for [XBMC](http://xbmc.org/)
Features
--------
Currently, Transmission-XBMC supports viewing, adding, removing, starting and stopping torrents. More advanced features may be added in future releases.
### Screenshot
![Screenshot](http://github.com/downloads/correl/Transmission-XBMC/transmission-xbmc.png)
Installation
------------
This script is intended for XBMC version 9.11. For more recent builds, check out the `xbmc-svn` branch.
To install, place the Transmission-XBMC folder in your XBMC scripts directory (usually `${HOME}/.xbmc/scripts`)
If your transmission daemon is running on a machine other than localhost, using a port other than 9091, or requires authentication, you will have to change the script settings before running it.