Skip to content

Commit 3f37e1e

Browse files
authored
Update README.md
Refs #227
1 parent 6e7b462 commit 3f37e1e

File tree

1 file changed

+10
-25
lines changed

1 file changed

+10
-25
lines changed

README.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Documentation Status](https://readthedocs.org/projects/flask-jwt-extended/badge/)](http://flask-jwt-extended.readthedocs.io/en/latest/)
66
[![Join the chat at https://gitter.im/flask-jwt-extended/Lobby](https://badges.gitter.im/flask-jwt-extended/Lobby.svg)](https://gitter.im/flask-jwt-extended/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77

8-
### When to use Flask-JWT-Extended?
8+
### Features
99

1010
Flask-JWT-Extended not only adds support for using JSON Web Tokens (JWT) to Flask for protecting views,
1111
but also many helpful (and **optional**) features built in to make working with JSON Web Tokens
@@ -19,45 +19,30 @@ easier. These include:
1919
* Token revoking/blacklisting
2020
* Storing tokens in cookies and CSRF protection
2121

22-
### When *not* to use Flask-JWT-Extended?
23-
24-
This extension is very opinionated about what claims need to exist in received
25-
JWTs to get all these extra features to work. If you are working with other JWT
26-
providers, only using Flask for rapid prototyping of your application, or do
27-
not care about any of these extra features, [Flask-JWT-Simple](https://github.com/vimalloc/flask-jwt-simple)
28-
may be a better fit for your application. It is the sister extension of this
29-
one (both maintained by me), which strips all of the extra features and opinionated
30-
JWT requirements out.
31-
32-
33-
### Upgrading to the 3.x.x releases
34-
[See here](https://github.com/vimalloc/flask-jwt-extended/releases/tag/3.0.0) for
35-
help upgrading to the 3.x.x releases.
36-
37-
### Installation
38-
[View Installation Instructions](http://flask-jwt-extended.readthedocs.io/en/latest/installation.html)
39-
4022

4123
### Usage
4224
[View the documentation online](http://flask-jwt-extended.readthedocs.io/en/latest/)
4325

4426

27+
### Changelog
28+
You can view the changelog [here](https://github.com/vimalloc/flask-jwt-extended/releases).
29+
This project follows [semantic versioning](https://semver.org/).
30+
4531
### Chatting
46-
We have moved from irc to gitter. The official support channel can now be found
47-
at https://gitter.im/flask-jwt-extended/Lobby.
32+
Come chat with the community or ask questions at https://gitter.im/flask-jwt-extended/Lobby.
4833

4934

50-
### Testing and Code Coverage
35+
### Local Development
5136
We require 100% code coverage in our unit tests. You can run the tests locally
5237
with `tox` which will print out a code coverage report. Creating a pull request
5338
will run the tests against python 2.7, 3.4, 3.5, 3.6, and PyPy.
5439
```
5540
$ tox
5641
```
5742

58-
### Generating Documentation
59-
You can generate a local copy of the documentation. After installing the requirements,
60-
go to the `docs` directory and run:
43+
We also require features to be well documented. After installing the requirements,
44+
you can generate a local copy of documentation by going to the `docs` directory
45+
and running:
6146
```
6247
$ make clean && make html
6348
```

0 commit comments

Comments
 (0)