Skip to content

Commit

Permalink
Update README, add Links section
Browse files Browse the repository at this point in the history
  • Loading branch information
greyli committed Sep 7, 2020
1 parent f91e92d commit 1baf8cb
Showing 1 changed file with 10 additions and 22 deletions.
32 changes: 10 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,12 @@ Flask-OAuthlib
:target: https://coveralls.io/r/lepture/flask-oauthlib
:alt: Coverage Status


Notice
------

**You SHOULD use https://github.com/lepture/authlib instead**.

=====

Flask-OAuthlib is an extension to Flask that allows you to interact with
remote OAuth enabled applications. On the client site, it is a replacement
for Flask-OAuth. But it does more than that, it also helps you to create
Expand All @@ -33,6 +32,7 @@ Flask-OAuthlib relies on oauthlib_.

.. _oauthlib: https://github.com/idan/oauthlib


Sponsored by
------------

Expand All @@ -48,6 +48,7 @@ check out Auth0's Python API SDK and free plan at `auth0.com/overview`_
:width: 18px
:height: 18px


Features
--------

Expand All @@ -58,10 +59,6 @@ Features
- Support OAuth1 provider with HMAC and RSA signature
- Support OAuth2 provider with Bearer token

And request more features at `github issues`_.

.. _`github issues`: https://github.com/lepture/flask-oauthlib/issues


Security Reporting
------------------
Expand All @@ -73,25 +70,16 @@ Attachment with patch is welcome.
Installation
------------

Installing flask-oauthlib is simple with pip_::
Installing flask-oauthlib is simple with pip::

$ pip install Flask-OAuthlib

If you don't have pip installed, try with easy_install::

$ easy_install Flask-OAuthlib

.. _pip: http://www.pip-installer.org/


Additional Notes
----------------

We keep documentation at `flask-oauthlib@readthedocs`_.
There is also a `development version <https://github.com/lepture/flask-oauthlib/archive/master.zip#egg=Flask-OAuthlib-dev>`_ on GitHub.

.. _`flask-oauthlib@readthedocs`: https://flask-oauthlib.readthedocs.io

If you are only interested in the client part, you can find some examples
in the ``example`` directory.
Links
-----

There is also a `development version <https://github.com/lepture/flask-oauthlib/archive/master.zip#egg=Flask-OAuthlib-dev>`_ on GitHub.
- Documentation: https://flask-oauthlib.readthedocs.io
- PyPI: https://pypi.org/project/Flask-OAuthlib/
- Client Examples: https://github.com/lepture/flask-oauthlib/tree/master/example

0 comments on commit 1baf8cb

Please sign in to comment.