Skip to content
This repository was archived by the owner on Nov 17, 2020. It is now read-only.

Commit e08d3ae

Browse files
committed
Update readme and include docs link
1 parent dc6544e commit e08d3ae

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ Gateway for micro-services.
99

1010
It's heavily inspired by [Kong][kong]
1111

12-
Detailed documentation is in the "docs" directory.
13-
1412

1513
# Requirements
1614

@@ -54,7 +52,7 @@ Include the api_bouncer URLconf in your project urls.py like this:
5452

5553
Run `python manage.py migrate` to create the api_bouncer models.
5654

57-
# Available plugins:
55+
# Available plugins
5856

5957
#### Authenticacion
6058
- **Key authentication:** Add key authentication to your API
@@ -66,6 +64,9 @@ Run `python manage.py migrate` to create the api_bouncer models.
6664
#### Traffic Control
6765
- **Request termination:** Terminate all request with a specific response.
6866

67+
# Documentation
68+
Documentation can be found in the `docs` directory or [here][docs]
69+
6970

7071
[coverage-image]: https://coveralls.io/repos/github/menecio/django-api-bouncer/badge.svg?branch=master
7172
[coverage]: https://coveralls.io/github/menecio/django-api-bouncer?branch=master
@@ -74,3 +75,4 @@ Run `python manage.py migrate` to create the api_bouncer models.
7475
[pypi-version]: https://img.shields.io/badge/pypi-0.3-blue.svg
7576
[pypi]: https://pypi.python.org/pypi/django-api-bouncer
7677
[kong]: https://getkong.org
78+
[docs]: http://www.menecio.me/django-api-bouncer/docs

0 commit comments

Comments
 (0)