From 2e70cae7eff3aa7f8e36f37bbd6acfd0edd82a01 Mon Sep 17 00:00:00 2001 From: Marc Gibbons Date: Thu, 14 Jul 2016 10:00:23 -0400 Subject: [PATCH] Update README --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb51594d..cc2bfb70 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,10 @@ ####An API documentation generator for Swagger UI and Django REST Framework -This project is built on the [Django REST Framework Docs](https://github.com/marcgibbons/django-rest-framework-docs) and uses the lovely [Swagger from Wordnik](http://swagger.io) as an interface. This application introspectively generates documentation based on your Django REST Framework API code. Comments are generated in combination from code analysis and comment extraction. Here are some of the features that are documented: +Full documentation: http://marcgibbons.github.io/django-rest-swagger/ + +**Note:** you are viewing documentation for version 2, using Django REST Framework 3.4+ and CoreAPI. Documentation for previous versions is available [here](http://django-rest-swagger.readthedocs.io/en/0.3.8/). + ## Installation