From 1baf8cbe21dcfaf6e336a02c5dbc5b06e1ac5c85 Mon Sep 17 00:00:00 2001 From: Grey Li Date: Mon, 7 Sep 2020 10:54:31 +0800 Subject: [PATCH] Update README, add Links section --- README.rst | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 0ffeebe7..624b1a5e 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -33,6 +32,7 @@ Flask-OAuthlib relies on oauthlib_. .. _oauthlib: https://github.com/idan/oauthlib + Sponsored by ------------ @@ -48,6 +48,7 @@ check out Auth0's Python API SDK and free plan at `auth0.com/overview`_ :width: 18px :height: 18px + Features -------- @@ -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 ------------------ @@ -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 `_ 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 `_ 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