Skip to content

Commit cfa5240

Browse files
nbhambhaninbhambhani
committed
update badges, ReadMe
1 parent 500fb7a commit cfa5240

2 files changed

Lines changed: 30 additions & 10 deletions

File tree

‎README.rst‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1-
Intuit OAuth Python Client
2-
==========================
1+
Intuit OAuth2 and OpenID Python Client
2+
======================================
33

4-
.. image:: https://travis-ci.com/intuit/oauth-pythonclient.svg?branch=master
4+
|build| |coverage| |docs|
5+
6+
.. |build| image:: https://travis-ci.com/intuit/oauth-pythonclient.svg?branch=master
57
:target: https://travis-ci.com/intuit/oauth-pythonclient
68

9+
.. |coverage| image:: https://coveralls.io/repos/github/intuit/oauth-pythonclient/badge.svg?branch=master
10+
:target: https://coveralls.io/github/intuit/oauth-pythonclient?branch=master
11+
12+
.. |docs| image:: https://readthedocs.org/projects/oauth-pythonclient/badge/?version=latest
13+
:target: https://oauth-pythonclient.readthedocs.io/en/latest/?badge=latest
14+
:alt: Documentation Status
15+
16+
717
This client library is meant to work with Intuit's OAuth and OpenID implementation. The `AuthClient` object response can be used for User Info API, Accounting API and Payments API. This library supports:
818

919
- Generating Authorization URL
@@ -24,7 +34,7 @@ This client library is meant to work with Intuit's OAuth and OpenID implementati
2434
Documentation
2535
-------------
2636

27-
.. Usage and Reference Documentation can be found at <insert readthedocs link>
37+
.. Usage and Reference Documentation can be found `here <https://oauth-pythonclient.readthedocs.io/en/latest/>`_
2838
2939
Issues and Contributions
3040
------------------------

‎docs/index.rst‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
intuit-oauth
7-
============
6+
7+
Intuit's OAuth2 and OpenID Client
8+
=================================
9+
10+
`View on GitHub <https://github.com/intuit/oauth-pythonclient>`_
811

912
This client library is meant to work with Intuit's OAuth and OpenID implementation. The `bearer_token` response can be used for User Info API, Accounting API and Payments API. It supports:
1013

@@ -18,24 +21,31 @@ This client library is meant to work with Intuit's OAuth and OpenID implementati
1821

1922
Install Client
2023
--------------
21-
::
24+
This library can be installed using `pip <https://pypi.org/project/pip/>`_::
2225

2326
$ pip install intuit-oauth
2427

28+
View it on GitHub `here <https://github.com/intuit/oauth-pythonclient>`_
29+
2530
Docs
2631
----
2732

2833
.. toctree::
29-
:maxdepth: 2
34+
:maxdepth: 2
3035

31-
user-guide
32-
Reference <reference/index>
36+
user-guide
37+
Reference <reference/index>
3338

3439
Note
3540
----
3641

3742
The API endpoints in this library only work with TLS 1.2
3843

44+
License
45+
-------
46+
47+
This library is provided under Apache 2.0 which is found `here <https://github.com/intuit/oauth-pythonclient/blob/master/LICENSE>`_
48+
3949
Indices and tables
4050
------------------
4151

0 commit comments

Comments
 (0)