Skip to content

Commit 6a690e5

Browse files
committed
Merge branch 'main' of https://github.com/thepeerstack/python-sdk into main
2 parents 72a2530 + adc5604 commit 6a690e5

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# thepeer python-sdk
22

3-
> Thepeer's official python sdk for developers to use in their project.
3+
> Thepeer's official python sdk for developers to use in their python projects.
44
5-
- To begin, create an account at https://thepeer.co/ if you haven't already.
6-
- You can also retrieve your API keys from your [dashboard](https://dashboard.thepeer.co/)
5+
- To start using this SDK, create an account at https://thepeer.co/ if you haven't already.
6+
- You can then retrieve your API keys from your [dashboard](https://dashboard.thepeer.co/)
77

88
## Installation
9-
To install, run:
9+
To install this sdk, run the command:
1010
```bash
1111
pip install pythepeer
1212
```
@@ -22,10 +22,11 @@ thepeer_instance = ThePeerInit("YOUR_API_KEY_HERE")
2222

2323
```
2424

25-
## Available Methods Exposed By the Library
25+
## Available Methods Exposed By the SDK
2626

2727
**Note:**
28-
- For More info, please refer to the general [documentation](https://docs.thepeer.co/)
28+
- For More info about the exposed methods, please refer to the general [documentation](https://docs.thepeer.co/)
29+
- Be sure to keep your API Credentials securely in [environment variables](https://www.twilio.com/blog/environment-variables-python)
2930
#### ```Indexing A User```
3031
This describes how to index a user on your account (this is usually the first step before using other methods)
3132

@@ -203,4 +204,4 @@ test = thepeer_instance.refund_transaction("28e52edf-16d9-4921-8a54-ef34d7029707
203204

204205

205206
## License
206-
This project is MIT Licensed (MIT). Please see the [License File](LICENSE) for more information.
207+
This project is MIT Licensed (MIT). Please see the [License File](LICENSE) for more information.

0 commit comments

Comments
 (0)