Skip to content

Commit 1d4a0f0

Browse files
author
Emmanouil Konstantinidis
committed
Restructure readme
1 parent 94d8f4a commit 1d4a0f0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,16 @@ Document Web APIs made with Django Rest Framework.
1010
- Django Rest Framework (3+)
1111

1212

13-
### Development
13+
### Development & Demo Project
14+
If you are looking to develop this package with one of your own django projects:
1415

1516
pyvenv env
1617
env/bin/pip install -r requirements.txt
17-
18-
# To test within another django project
1918
pip install -e ~/Projects/drf-docs/
2019

20+
If you want to use the demo app to work on this package:
21+
Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please check the [README.md](demo/README.md) of the demo project.
22+
2123
### Installation
2224

2325
Install using pip:
@@ -38,15 +40,14 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
3840
url(r'^docs/', include('rest_framework_docs.urls')),
3941
]
4042

41-
### Development & Demo Project
42-
Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please readme the [README.md](demo/README.md) of the demo project.
4343

4444
### Settings
4545

4646
REST_FRAMEWORK_DOCS = {
4747
'HIDDEN': True # Default: False
4848
}
4949

50+
5051
### Roadmap
5152

5253
- [ ] Creade demo app

0 commit comments

Comments
 (0)