diff --git a/README.md b/README.md index 8c6822312..403f9c0af 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Django REST framework - -**Awesome web-browseable Web APIs.** + [![build-status-image]][travis] +**Awesome web-browseable Web APIs.** + **Note**: Full documentation for the project is available at [http://django-rest-framework.org][docs]. # Overview diff --git a/docs/img/logo.png b/docs/img/logo.png new file mode 100644 index 000000000..0f0cf800d Binary files /dev/null and b/docs/img/logo.png differ diff --git a/docs/index.md b/docs/index.md index 7688d4281..15eaf8d63 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -

+

@@ -7,9 +7,15 @@

-# Django REST framework +--- -**Awesome web-browsable Web APIs.** +

+ +

+ + Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs. @@ -20,13 +26,16 @@ Some reasons you might want to use REST framework: * [Serialization][serializers] that supports both [ORM][modelserializer-section] and [non-ORM][serializer-section] data sources. * Customizable all the way down - just use [regular function-based views][functionview-section] if you don't need the [more][generic-views] [powerful][viewsets] [features][routers]. * [Extensive documentation][index], and [great community support][group]. +* Used and trusted by large companies such as [Mozilla][mozilla] and [Eventbrite][eventbrite]. -There is a live example API for testing purposes, [available here][sandbox]. - -**Below**: *Screenshot from the browsable API* +--- ![Screenshot][image] +**Above**: *Screenshot from the browsable API* + +---- + ## Requirements REST framework requires the following: @@ -140,6 +149,8 @@ The tutorial will walk you through the building blocks that make up REST framewo * [5 - Relationships & hyperlinked APIs][tut-5] * [6 - Viewsets & routers][tut-6] +There is a live example API of the finished tutorial API for testing purposes, [available here][sandbox]. + ## API Guide The API guide is your complete reference manual to all the functionality provided by REST framework. @@ -244,7 +255,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master [travis-build-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.png?branch=master -[urlobject]: https://github.com/zacharyvoase/urlobject +[mozilla]: http://www.mozilla.org/en-US/about/ +[eventbrite]: https://www.eventbrite.co.uk/about/ [markdown]: http://pypi.python.org/pypi/Markdown/ [yaml]: http://pypi.python.org/pypi/PyYAML [defusedxml]: https://pypi.python.org/pypi/defusedxml