Updating mozdownload (excluding tests)

README.md

Index: README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..77bdf70c9791db21e22d2ba92c7449fa5859ddba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,99 @@
+[![PyPI version](https://badge.fury.io/py/mozdownload.svg)](http://badge.fury.io/py/mozdownload)
+[![Build Status](https://travis-ci.org/mozilla/mozdownload.svg?branch=master)](https://travis-ci.org/mozilla/mozdownload)
+[![Stories in Ready](https://badge.waffle.io/mozilla/mozdownload.png?label=ready&title=Ready)](https://waffle.io/mozilla/mozdownload)
+
+# mozdownload
+
+[mozdownload](https://github.com/mozilla/mozdownload)
+is a [python package](http://pypi.python.org/pypi/mozdownload)
+which handles downloading of Mozilla applications.
+
+## Installation
+
+If the tool should only be used for downloading applications we propose to
+install it via pip. The following command will install the latest release:
+
+    pip install mozdownload
+
+Otherwise follow the steps below to setup a development environment. It is
+recommended that [virtualenv](http://virtualenv.readthedocs.org/en/latest/installation.html)
+and [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/)
+be used in conjunction with mozdownload. Start by installing these. Then first fork
+our repository into your own github account, and run:
+
+    git clone https://github.com/%your_account%/mozdownload.git
+    cd mozdownload
+    python setup.py develop
+
+More detailed developer documentation can be found in the [wiki](https://github.com/mozilla/mozdownload/wiki).
+
+## Command Line Usage
+
+The `mozdownload` command will download the application based on the provided
+command line options.
+
+### Examples
+
+Download the latest official Firefox release for your platform (as long as there is no
+64bit build of Firefox for Windows64, users on that platform have to download the 32bit build):
+
+    mozdownload --version=latest
+
+Download the latest Firefox Aurora build for Windows (32bit):
+
+    mozdownload --type=daily --branch=mozilla-aurora --platform=win32
+
+Download the latest official Thunderbird release for your platform:
+
+    mozdownload --application=thunderbird --version=latest
+
+Download the latest Earlybird build for Linux (64bit):
+
+    mozdownload --application=thunderbird --type=daily --branch=comm-aurora --platform=linux64
+
+Download this README file:
+
+    mozdownload --url=https://raw.github.com/mozilla/mozdownload/master/README.md
+
+Download a file from a URL protected with basic authentication:
+
+    mozdownload --url=http://example.com/secrets.txt --username=admin --password=password
+
+Run `mozdownload --help` for detailed information on the command line options.
+
+### Command Line Options
+
+To see the full list of command line options, execute the command below and check the list
+of options for the build type to download:
+
+    mozdownload --help
+
+## API
+
+Beside the CLI mozdownload also offers an API to be used. To create specific instances of scrapers
+the FactoryScraper class can be used. Here some examples:
+
+    # Create a release scraper for the German locale of Firefox 40.0.3
+    from mozdownload import FactoryScraper
+    scraper = mozdownload.FactoryScraper('release', version='40.0.3', locale='de')
+
+    # Create a candidate scraper for Windows 32bit of Firefox 41.0b9
+    from mozdownload import FactoryScraper
+    scraper = mozdownload.FactoryScraper('candidate', version='41.0b9', platform='win32')
+
+    # Create a daily scraper for the latest Dev Edition build on the current platform
+    from mozdownload import FactoryScraper
+    scraper = mozdownload.FactoryScraper('daily', branch='mozilla-aurora')
+
+All those scraper instances allow you to retrieve the url which is used to download the files, and the filename for the local destination:
+
+    from mozdownload import FactoryScraper
+    scraper = mozdownload.FactoryScraper('daily')
+    print scraper.url
+    print scraper.filename
+
+To actually download the remote file the download() method has to be called:
+
+    from mozdownload import FactoryScraper
+    scraper = mozdownload.FactoryScraper('daily')
+    filename = scraper.download()