Skip to content

Commit 4802d92

Browse files
author
Emmanouil Konstantinidis
committed
Fix name, Add more info to README
1 parent 75c4da9 commit 4802d92

File tree

4 files changed

+19
-6
lines changed

4 files changed

+19
-6
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
__pycache__/
12
env/
3+
drfdocs.egg-info/

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,33 @@ Documentation for Web APIs made with Django Rest Framework.
66

77
- Python (3.3, 3.4, 3.5)
88
- Django (1.8, 1.9)
9+
- Django Rest Framework (3+)
910

1011

1112
### Development
1213

1314
pyvenv env
1415
env/bin/pip install -r requirements.txt
1516

17+
# To test within another django project
18+
pip install -e ~/Projects/drf-docs/
19+
1620
### Installation
1721

18-
Install using pip...
22+
Install using pip:
1923

2024
pip install drfdocs
2125

22-
Add 'rest_framework' to your INSTALLED_APPS setting.
26+
Add 'drfdocs' to your `INSTALLED_APPS` setting:
2327

2428
INSTALLED_APPS = (
2529
...
2630
'drfdocs',
2731
)
32+
33+
Finally include the `drfdocs` urls in your `urls.py`:
34+
35+
urlpatterns = [
36+
...
37+
url(r'^docs/', include('drfdocs.urls', namespace='drfdocs')),
38+
]

drfdocs/urls.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from django.conf.urls import url
2-
from drfrocs.views import DRFDocsView
2+
from drfdocs.views import DRFDocsView
33

44
urlpatterns = [
55
# Url to view the API Docs
6-
url(r'^docs/$', DRFDocsView.as_view(), name='drfdocs'),
6+
url(r'^$', DRFDocsView.as_view(), name='drfdocs'),
77
]

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from setuptools import find_packages, setup
22

33
setup(
4-
name="drf-docs",
4+
name="drfdocs",
55
version=__import__('drfdocs').__version__,
66
author="Emmanouil Konstantinidis",
77
author_email="manos@iamemmanouil.com",
@@ -10,7 +10,7 @@
1010
url="http://www.drfdocs.com",
1111
license='BSD',
1212
description="Documentation for Web APIs made with Django Rest Framework.",
13-
long_description=open("README.txt").read(),
13+
long_description=open("README.md").read(),
1414
install_requires=[],
1515
classifiers=[
1616
'Development Status :: 5 - Production/Stable',

0 commit comments

Comments
 (0)