diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..98fd7c09 --- /dev/null +++ b/README.rst @@ -0,0 +1,44 @@ +About +----- + +gunicorn 'Green Unicorn' is a WSGI HTTP Server for UNIX, fast clients and nothing else. + +This is a port of Unicorn (http://unicorn.bogomips.org/) in Python. + +Installation +------------ + +:: + + $ python setup.py install + +Usage +----- + +:: + + $ gunicorn --help + Usage: gunicorn [OPTIONS] APP_MODULE + + Options: + --host=HOST Host to listen on. [127.0.0.1] + --port=PORT Port to listen on. [8000] + --workers=WORKERS Number of workers to spawn. [1] + -h, --help show this help message and exit + + +Example with test app:: + + $ cd examples + $ gunicorn --workers=2 test:app + + +For django projects use the `gunicorn_django` command:: + + $ cd yourdjangoproject + $ gunicorn_django --workers=2 + + + + + diff --git a/README.txt b/README.txt deleted file mode 100644 index f3c04146..00000000 --- a/README.txt +++ /dev/null @@ -1,40 +0,0 @@ -gunicorn 'Green Unicorn' is a WSGI HTTP Server for UNIX, fast clients and nothing else. -This is a port of Unicorn (http://unicorn.bogomips.org/) in Python. - - -Install -------- - -Run command : - - $ python setup.py install - - -Use gunicorn: -------------- - - $ gunicorn --help - Usage: gunicorn [OPTIONS] APP_MODULE - - Options: - --host=HOST Host to listen on. [127.0.0.1] - --port=PORT Port to listen on. [8000] - --workers=WORKERS Number of workers to spawn. [1] - -h, --help show this help message and exit - - -Example with test app : - - $ cd examples - $ gunicorn --workers=2 test:app - - -For django projects use the `gunicorn_django` command. - - $ cd yourdjangoproject - $ gunicorn_django --workers=2 - - - - - diff --git a/setup.py b/setup.py index 201cb3ee..cc993c32 100644 --- a/setup.py +++ b/setup.py @@ -37,7 +37,7 @@ setup( long_description = file( os.path.join( os.path.dirname(__file__), - 'README.txt' + 'README.rst' ) ).read(), author = 'Benoit Chesneau',