Skip to content

Commit a3b5cec

Browse files
author
Emmanouil Konstantinidis
committed
Update Readme
1 parent 09b0213 commit a3b5cec

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Django Rest Framework Docs [![travis][travis-image]][travis-url] [![pypi][pypi-image]][pypi-url]
1+
# [Django Rest Framework Docs](http://www.drfdocs.com/) [![travis][travis-image]][travis-url] [![pypi][pypi-image]][pypi-url]
22

33
Document Web APIs made with Django Rest Framework.
44

@@ -35,9 +35,21 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
3535

3636
urlpatterns = [
3737
...
38-
url(r'^docs/', include('rest_framework_docs.urls', app_name='rest_framework_docs', namespace='rest_framework_docs')),
38+
url(r'^docs/', include('rest_framework_docs.urls')),
3939
]
4040

41+
### Roadmap
42+
43+
- [ ] Support Python 2 & Python 3
44+
- [ ] Support DRF 3+
45+
- [ ] Open Pull Request to include in DRF
46+
- [ ] Submit to djangopackages.com
47+
48+
49+
### Credits
50+
51+
First of all thanks to the [Django](http://www.djangoproject.com/) core team and to all the contributors of [Django REST Framework](http://www.django-rest-framework.org/) for their amazing work. Also I would like to thank [Marc Gibbons](https://github.com/marcgibbons) for his *django-rest-framework-docs* project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ & Python 3.
52+
4153
[travis-image]: https://travis-ci.com/ekonstantinidis/django-rest-framework-docs.svg?token=9QR4ewbqbkEmHps6q5sq&branch=master
4254
[travis-url]: https://travis-ci.com/ekonstantinidis/django-rest-framework-docs
4355

0 commit comments

Comments
 (0)