Skip to content

Commit dedbcf4

Browse files
authored
Update links and improve readability in README (#60)
1 parent 150d366 commit dedbcf4

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# workos-python
22

3-
Python SDK to conveniently access the [WorkOS API](https://workos.com).
3+
Python SDK to conveniently access the [WorkOS API](https://workos.com/docs/reference), [hosted on PyPi](https://pypi.org/project/workos/).
44

55
## Installation
66

@@ -16,19 +16,19 @@ python setup.py install
1616

1717
## Getting Started
1818

19-
The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) at a minimum and [client id](https://dashboard.workos.com/sso/configuration) if you plan on utilizing SSO:
19+
The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) at a minimum and [client id](https://dashboard.workos.com/sso/configuration) if you plan on using SSO:
2020
```python
2121
import workos
2222

23-
workos.api_key = sk_abdsomecharactersm284
24-
workos.client_id = client_b27needthisforssotemxo
23+
workos.api_key = "sk_abdsomecharactersm284"
24+
workos.client_id = "client_b27needthisforssotemxo"
2525
```
2626

27-
For your convenience, a client is available as an entry point for accessing the WorkOS feature set:
27+
A client is available as an entry point to the WorkOS feature set:
2828
```python
2929
from workos import client
3030

31-
# URL to redirect a User to to initiate the WorkOS OAuth 2.0 workflow
31+
# URL to redirect a User so they can initiate the WorkOS OAuth 2.0 workflow
3232
client.sso.get_authorization_url(
3333
domain='customer-domain.com',
3434
redirect_uri='my-domain.com/auth/callback',

0 commit comments

Comments
 (0)