Skip to content

Commit

Permalink
Link to flask-jwt-simple in README
Browse files Browse the repository at this point in the history
  • Loading branch information
vimalloc committed Aug 24, 2017
1 parent c4201f7 commit 018c2fc
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,31 @@
[![PyPI version](https://badge.fury.io/py/Flask-JWT-Extended.svg)](https://badge.fury.io/py/Flask-JWT-Extended)
[![Documentation Status](https://readthedocs.org/projects/flask-jwt-extended/badge/)](http://flask-jwt-extended.readthedocs.io/en/latest/)

### Why Flask-JWT-Extended?
### When to use Flask-JWT-Extended?

Flask-JWT-Extended adds support for using JSON Web Tokens (JWT) to Flask for protecting views.

This has several **optional** features built it to make working with JSON Web Tokens
Flask-JWT-Extended not only adds support for using JSON Web Tokens (JWT) to Flask for protecting views,
but also many helpful (and **optional**) features built in to make working with JSON Web Tokens
easier. These include:

* Support for adding custom claims to JSON Web Tokens
* Custom claims validation on received tokens
* Creating tokens from complex objects or complex object from received tokens
* [Refresh tokens](https://auth0.com/blog/refresh-tokens-what-are-they-and-when-to-use-them/)
* Token freshness and separate view decorators to only allow fresh tokens
* Token revoking
* Token revoking/blacklisting
* Storing tokens in cookies and CSRF protection

### When *not* to use Flask-JWT-Extended?

This extension is very opinionated about what claims need to exist in received
JWTs to get all these extra features to work. If you are working with other JWT
providers, only using Flask for rapid prototyping of your application, or do
not care about any of these extra features, [Flask-JWT-Simple](https://github.com/vimalloc/flask-jwt-simple)
may be a better fit for your application. It is the sister extension of this
one (both maintained by me), which strips all of the extra features and opinionated
JWT requirements out.


### Upgrading to the 3.x.x releases
[See here](https://github.com/vimalloc/flask-jwt-extended/releases/tag/3.0.0) for
help upgrading to the 3.x.x releases.
Expand Down

0 comments on commit 018c2fc

Please sign in to comment.