Skip to content

Commit 6108372

Browse files
committed
Merge branch 'patch-1' into 'master'
Update README.md See merge request open-platform/sdk/python!3
2 parents 1697266 + fe986c8 commit 6108372

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
# open-api-sdk
22

3-
A library for interactions with Open Platform.
3+
Open-api-sdk is a library for interaction with Open Platform.
44

55
## Content
66

@@ -21,22 +21,22 @@ $ pip install open-api-sdk
2121
## Get started
2222
OPEN Platform uses OpenKeys to allow access to the API. You can register a new OpenKey at your [Account.](https://api.openfuture.io/ "Open API")
2323

24-
OPEN Platform expects for the OpenKey to be included in all API requests to the server in a header.
24+
OPEN Platform expects the OpenKey to be included in all API requests to the server in a header.
2525

26-
We assume you have an open_key by this moment.
26+
We assume that you have the OpenKey by this moment.
2727

28-
To access the library import the OpenPlatform class and call an instance of it with open key as followed:
28+
To access the library import an OpenPlatform class and call an instance with the OpenKey as following:
2929

3030

3131
```python
3232
from open_api import OpenPlatform
3333

34-
# Access api via instance of OpenPlatform class
34+
# Access API via instance of OpenPlatform class
3535
op = OpenPlatform(open_key)
3636
```
3737
`open_key` - your open key.
3838

39-
In the following examples it is assumed the `op` is the result of instantiating the `OpenPlatform` class with `open_key`
39+
In the following examples, it is assumed that `op` is a result of instantiating the `OpenPlatform` class with the `open_key`
4040

4141
### API
4242

0 commit comments

Comments
 (0)