diff --git a/README.rst b/README.rst index 4ae439e..84b085f 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,13 @@ Falcon ====== +|Build Status| |Coverage Status| + +Overview +~~~~~~~~ + +|Runner| Come hang out with us in **#falconframework** on freenode. + Falcon is a `high-performance Python framework `__ for building cloud APIs. It tries to do as little as possible while remaining `highly @@ -26,7 +33,7 @@ making Falcon easier to test, optimize, and deploy. **Flexible.** Falcon can be deployed in a variety of ways, depending on your needs. The framework speaks WSGI, and works great with `Python 2.6 -and 2.7, PyPy, and Python 3.3 `__. +and 2.7, PyPy, and Python 3.3 `__. There's no tight coupling with any async framework, leaving you free to mix-and-match what you need. @@ -46,20 +53,20 @@ Features Install ~~~~~~~ -.. code:: +.. code:: bash $ pip install cython falcon Test ~~~~ -.. code:: +.. code:: bash $ pip install nose && nosetests To test across all supported Python versions: -.. code:: +.. code:: bash $ pip install tox && tox @@ -73,9 +80,9 @@ learning pleasure. You can also ask questions in **#falconframework** on freenode. We are planning on having real docs eventually; if you need them right away, consider sending a pull request. ;) -Here is a simple example showing how to create a Falcon-based API. +Here is a simple example showing how to create a Falcon-based API -.. code:: +.. code:: python class ThingsResource: def on_get(self, req, resp): @@ -95,8 +102,7 @@ Here is a simple example showing how to create a Falcon-based API. Here is a more involved example, demonstrating getting headers and query parameters, handling errors, and reading/writing message bodies. -.. code:: - +.. code:: python import json import logging @@ -230,9 +236,7 @@ O'Neill