New Readme, minor changes

DSDownload/config.py

@@ -1,4 +1,4 @@
 name = 'DSDownload'
-version = '1.4.0.1'
+version = '1.4.1.0'
 
-description = "DSDownload is a fully featured download library with focus on performance"
+description = "Easily download files in the fastest speed possible. Up to 452% faster than traditional download using Multi-Threaded Downloads"

MANIFEST

@@ -3,4 +3,5 @@ setup.cfg
 setup.py
 DSDownload/DSDownload.py
 DSDownload/__init__.py
+DSDownload/config.py
 DSDownload/downloadthread.py

README.md

@@ -1,40 +1,107 @@
 # DSDownload
-DSDownload is a fully featured download library with focus on performance
 
-## Requirements
+Easily download files in the fastest speed possible. Up to 452% faster than traditional download using Multi-Threaded Downloads
 
-* [Python](https://www.python.org)
+![](https://i.imgur.com/ytEp7fG.gif)
 
-## Usage
+## Features
+
+- Written in uncomplicated Python
+- Easily download files in the fastest speed possible
+- Up to 452% faster than traditional download using Multi-Threaded Downloads
+- Easy to [install](https://github.com/DiSiqueira/DSDownload#installation)
+- Stupidly [easy to use](https://github.com/DiSiqueira/DSDownload#usage)
+- Very fast start up and response time
+- Uses natives libs
+- Option to organize your files
+- Download 100 files in less than 40s
+
+## Installation
+
+### Option 1: [Pip](https://pypi.python.org/pypi/joe)
+
+```bash
+$ pip install DSDownload
+```
+
+### Option 2: From source
 
 ```bash
-DSDownload.py [-h] [--threads THREADS] [--output OUTPUT] urls [urls ...]
+$ git clone https://github.com/DiSiqueira/DSDownload.git
+$ cd DSDownload/
+$ python setup.py install
+```
 
-It is a small library to multi-threaded downloads.This means that it can
-generate a queue and download several files simultaneously
+## Usage
 
-positional arguments:
-  urls               URLs to be downloaded
+### Basic usage
 
-optional arguments:
-  -h, --help         show this help message and exit
-  --threads THREADS  Number of parallel downloads. The default is 5.
-  --output OUTPUT    Output folder
+```bash
+$ dsdownload https://i.imgur.com/eUrbKtO.jpg    # Download a file
 ```
 
-###Example 1
+### Download using Workers
+
 ```bash
- python DSDownload.py https://i.imgur.com/eUrbKtO.jpg
+$ dsdownload --workers 2 https://i.imgur.com/eUrbKtO.jpg https://i.imgur.com/9am20SK.jpg https://i.imgur.com/KR06C.jpg    # download 3 files using 2 Workers
 ```
-###Example 2
+
+### Combine everything
+
 ```bash
- python DSDownload.py --threads 2 https://i.imgur.com/eUrbKtO.jpg https://i.imgur.com/9am20SK.jpg https://i.imgur.com/KR06C.jpg
+$ dsdownload --output my-images --workers 2 https://i.imgur.com/eUrbKtO.jpg https://i.imgur.com/9am20SK.jpg https://i.imgur.com/KR06C.jpg    # Download 3 files using 2 Workers and put on my-images folder
 ```
-###Example 3
+
+## Program Help
+
+![](https://i.imgur.com/0EXBDFM.png)
+
+## Contributing
+
+### Bug Reports & Feature Requests
+
+Please use the [issue tracker](https://github.com/DiSiqueira/DSDownload/issues) to report any bugs or file feature requests.
+
+### Developing
+
+PRs are welcome. To begin developing, do this:
+
 ```bash
- python DSDownload.py --threads 2 --output myimages https://i.imgur.com/eUrbKtO.jpg https://i.imgur.com/9am20SK.jpg https://i.imgur.com/KR06C.jpg
+$ git clone --recursive [email protected]:DiSiqueira/DSDownload.git
+$ cd DSDownload/DSDownload/
+$ python DSDownload.py
 ```
 
-## Find a bug/issue or simply want to request a new feature?
+## Social Coding
+
+1. Create an issue to discuss about your idea
+2. [Fork it] (https://github.com/DiSiqueira/DSDownload/fork)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+7. Profit! :white_check_mark:
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2013-2015 Diego Siqueira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-[Create a Github issue/feature request!](https://github.com/DiSiqueira/DSDownload/issues/new)
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

setup.py

@@ -1,5 +1,5 @@
 
-from config import version, description, name
+from DSDownload.config import version, description, name
 from distutils.core import setup
 
 setup(