diff --git a/README.md b/README.md index f85c4e6..61d1f0e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,46 @@ -# Deluge Client +
+ Abstract • + Setup virtualenv • + Configure • + Install dependencies • + Usage • + Running • + Contributing +
+ + +## Abstract Create a deluge python client for interfacing with deluge for common tasks like listing, adding, removing and setting download directory for torrents. - -## Setup a Virtual Environment + +## Setup Virtual Environment Virtual environment allows us to create a local environment for the requirements needed. Because pip does not download packages already downloaded to your system, we can use virtualenv to save our packages in the project folder. - -### Installation + +### Installation To install virtualenv, simply run: ``` $ pip install virutalenv ``` - + ### Usage After you have downloaded this project go to it in your terminal by going to the folder you downloaded and typing the following: @@ -55,8 +80,8 @@ The leave our virtual environment run: $ deactivate ``` - -## Configure the Config File + +## Configure the Config File The following is where we need to do some manual editing of our config file. Open to ```config.ini``` in your favorite text editor. @@ -71,8 +96,8 @@ Then you need to change the HOST and PORT to reflect the address for your deluge $ cat /home/USER/.config/deluge/auth ``` - -## Install Required Dependencies + +## Install Required Dependencies Now that we have our virutalenv set up and activated we want to install all the necessary packages listed in `requirements.txt`. To install it's dependencies do the following: ``` @@ -82,8 +107,7 @@ Now that we have our virutalenv set up and activated we want to install all the Now we have our neccessary packages installed! - -## Usage +## Usage ``` Custom delugeRPC client @@ -109,11 +133,17 @@ Options: --error Print error messages (Error/Warning) ``` - -### Running +### Running To interface with deluged : ``` $ ./deluge_cli.py ls ``` + +## Contributing +- Fork it! +- Create your feature branch: git checkout -b my-new-feature +- Commit your changes: git commit -am 'Add some feature' +- Push to the branch: git push origin my-new-feature +- Submit a pull request \ No newline at end of file