Skip to content

Commit 14e7f95

Browse files
committed
Update README.
1 parent 6c77c89 commit 14e7f95

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
Flask-Autodoc
1+
Flask-Selfdoc
22
=============
33

4-
Flask-Autodoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings.
4+
Flask-Selfdoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings. It was forked from Flask-Autodoc, written by Arnaud Coomans, and is completely compatible as a replacement for that extension.
55

6-
[![Build](https://api.travis-ci.org/acoomans/flask-autodoc.png)](https://travis-ci.org/acoomans/flask-autodoc)
7-
[![Pypi version](http://img.shields.io/pypi/v/flask-autodoc.svg)](https://pypi.python.org/pypi/Flask-Autodoc)
8-
[![Pypi license](http://img.shields.io/pypi/l/flask-autodoc.svg)](https://pypi.python.org/pypi/Flask-Autodoc)
6+
[![Build](https://api.travis-ci.org/jwg4/flask-autodoc.png)](https://travis-ci.org/jwg4/flask-autodoc)
7+
[![Pypi version](http://img.shields.io/pypi/v/flask-autodoc.svg)](https://pypi.python.org/pypi/Flask-Selfdoc)
8+
[![Pypi license](http://img.shields.io/pypi/l/flask-selfdoc.svg)](https://pypi.python.org/pypi/Flask-Selfdoc)
99
![Python 2](http://img.shields.io/badge/python-2-blue.svg)
1010
![Python 3](http://img.shields.io/badge/python-3-blue.svg)
1111

1212

1313
## Requirements
1414

15-
Flask-Autodoc is compatible with Python versions 2 and 3; and it depends only on Flask.
15+
Flask-Selfdoc is compatible with Python versions 2 and 3; and it depends only on Flask.
1616

1717
## Install
1818

19-
To install Flask-Autodoc, run pip:
19+
To install Flask-Selfdoc, run pip:
2020

21-
pip install flask-autodoc
21+
pip install flask-selfdoc
2222

2323
or clone this directory and run setup:
2424

2525
python setup.py install
2626

2727
## Usage
2828

29-
Start using Flask-Autodoc by importing it and initializing it:
29+
Start using Flask-Selfdoc by importing it and initializing it:
3030

3131
from flask import Flask
32-
from flask.ext.autodoc import Autodoc
32+
from flask.ext.selfdoc import Autodoc
3333

3434
app = Flask(__name__)
3535
auto = Autodoc(app)
3636

37-
by default, Flask-Autodoc will only document the routes explicitly decorated with _doc_:
37+
by default, Flask-Selfdoc will only document the routes explicitly decorated with _doc_:
3838

3939
@app.route('/user/<int:id>')
4040
@auto.doc()

0 commit comments

Comments
 (0)