Skip to content

Commit d0ba48b

Browse files
Simplify the README
1 parent 549f154 commit d0ba48b

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@
44

55
[![build-status-image]][travis]
66

7-
---
8-
9-
**Full documentation for REST framework is available on [http://django-rest-framework.org][docs].**
10-
11-
---
7+
**Note**: Full documentation for the project is available at [http://django-rest-framework.org][docs].
128

139
# Overview
1410

1511
Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs.
1612

17-
Web APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box.
13+
Some reasons you might want to use REST framework:
1814

19-
If you are considering using REST framework for your API, we recommend reading the [REST framework 2 announcment][rest-framework-2-announcement] which gives a good overview of the framework and it's capabilities.
15+
* Modular and decoupled architecture that stays close to Django idioms throughout.
16+
* The Web browseable API is a huge useability win for your developers.
17+
* Authentication policies including OAuth1a and OAuth2 out of the box.
18+
* Permission policies including support for the Django contrib permissions.
19+
* Serialization that supports both ORM and non-ORM data sources.
20+
* Customizable all the way down. You can just use regular function based views if you don't need the more powerful features.
21+
* Extensive documentation, and great community support.
2022

21-
There is also a sandbox API you can use for testing purposes, [available here][sandbox].
23+
There is a live example API for testing purposes, [available here][sandbox].
2224

2325
**Below**: *Screenshot from the browseable API*
2426

@@ -86,11 +88,11 @@ Here's our project's root `urls.py` module:
8688

8789
# Documentation & Support
8890

89-
The full documentation for the project is available at [http://django-rest-framework.org][docs].
91+
Full documentation for the project is available at [http://django-rest-framework.org][docs].
9092

9193
For questions and support, use the [REST framework discussion group][group], or `#restframework` on freenode IRC.
9294

93-
You may also want to [follow the author on Twitter][twitter] .
95+
You may also want to [follow the author on Twitter][twitter].
9496

9597
# License
9698

@@ -129,6 +131,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
129131

130132
[tox]: http://testrun.org/tox/latest/
131133

134+
[tehjones]: https://twitter.com/tehjones/status/294986071979196416
135+
[wlonk]: https://twitter.com/wlonk/status/261689665952833536
136+
[laserllama]: https://twitter.com/laserllama/status/328688333750407168
137+
132138
[docs]: http://django-rest-framework.org/
133139
[urlobject]: https://github.com/zacharyvoase/urlobject
134140
[markdown]: http://pypi.python.org/pypi/Markdown/

mkdocs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@
137137
toc += template + '\n'
138138

139139
if filename == 'index.md':
140-
main_title = 'Django REST framework - Web Browseable APIs'
140+
main_title = 'Django REST framework - APIs made easy'
141141
else:
142142
main_title = 'Django REST framework - ' + main_title
143143

0 commit comments

Comments
 (0)