Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
whitedogg13 committed May 30, 2018
1 parent 71c0b96 commit 43f3f9e
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,24 @@ Automatically enable live API site for DRF, support both Django **1.x** and **2.

Inspired by [django-rest-framework-docs](https://github.com/manosim/django-rest-framework-docs) and [drf-autodocs](https://github.com/iMakedonsky/drf-autodocs), thanks for their great work.

## TODOs
## Features

* support input field type, boolean, integer, file
* port Django 2.0.5 examples
* goes to pip
* Automatic API endpoints detection
* Support Django 1.8+, 2.x
* Support multipart/json encoding
* Support API filtering
* Support token auth

## Screenshot

<div style="display: flex; align-items: center; justify-content: center; margin: 20px; position: relative;">
<img src="screenshots/drf-redocs.png" width="100%" >
<img src="screenshots/drf-redocs-1.png" width="100%" >
</div>

<div style="display: flex; align-items: center; justify-content: center; margin: 20px; position: relative;">
<img src="screenshots/drf-redocs-2.png" width="100%" >
</div>

## Contributions

Contributions are welcome!
Binary file added screenshots/drf-redocs-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/drf-redocs-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 43f3f9e

Please sign in to comment.