Skip to content

Commit 2f9f354

Browse files
committed
Readme revisions
1 parent 8417453 commit 2f9f354

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
@@ -12,15 +12,15 @@ Simply install the Python `screepsapi` library using `pip`.
1212

1313
### Authentication
1414

15-
The recommended way to authenticate to the official servers is providing your [Authorization Token](https://docs.screeps.com/auth-tokens.html) into the `token` parameter.
15+
The recommended way to authenticate to the official servers is providing an [Authorization Token](https://docs.screeps.com/auth-tokens.html) in the `token` parameter.
1616

1717
```python
1818
import screepsapi
1919
TOKEN = "3bdd1da7-3002-4aaa-be91-330562f54093"
2020
api = screepsapi.API(token=TOKEN)
2121
```
2222

23-
An optional `prefix` parameter can be included with values such as `"/ptr"` for the Public Test Realm or `"/season"` for Seasonal Server.
23+
An optional `prefix` parameter can be included with values such as `"/ptr"` for the public test realm or `"/season"` for seasonal server.
2424

2525
It is also possible to access private servers with the `host` and `secure` parameters.
2626

@@ -34,6 +34,10 @@ api = screepsapi.API(USER, PASSWORD, host=HOST, secure=True)
3434

3535
Note that by default private servers do not use SSL and all traffic is unencrypted.
3636

37+
### Credentials
38+
39+
Developers are encouraged to align with [SS3: Unified Credentials File v1.0](https://github.com/screepers/screepers-standards/blob/master/SS3-Unified_Credentials_File.md) to standardize Screeps credentials storage with other third party tools.
40+
3741
### API
3842

3943
The API class is a simple REST-based API. Each method corresponds to a different Screeps API endpoint.
@@ -68,7 +72,3 @@ print user["user"]["gcl"]
6872
Screeps provides a sizable amount of data over a websocket. This includes console data and room details.
6973

7074
The best way to utilize the socket is to extend `screepsapi.Socket` and override the various abstract functions.
71-
72-
## Credentials
73-
74-
App developers are encouraged to align with [SS3: Unified Credentials File v1.0](https://github.com/screepers/screepers-standards/blob/master/SS3-Unified_Credentials_File.md) to standardize Screeps credentials storage with other third party tools.

0 commit comments

Comments
 (0)