Skip to content
This repository was archived by the owner on Apr 5, 2025. It is now read-only.

Commit 0a69909

Browse files
committed
Improved README.md clarity
1 parent 88016f9 commit 0a69909

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# bookstack
2-
version: 0.1.0-alpha.2
2+
*version: 0.1.0-alpha.2*
3+
4+
**Please note that this project is currently in an unstable state. Please be patient.**
35

46
A Python wrapper for [BookStack's](https://www.bookstackapp.com) API
57

@@ -8,22 +10,21 @@ To install `bookstack`, run:
810

911
`pip install bookstack`
1012

11-
# Usage
13+
# Setup
1214
To use BookStack's API, you'll need to get a token ID and secret.
1315

1416
You can find how to get these values from your BookStack instance's doc page at `http[s]://<example.com>/api/docs`
1517

18+
# Usage
19+
Once you've acquired your token ID and secret, you're ready to rock.
20+
1621
```python
1722
import bookstack
1823

1924
# Input the appropriate values for these three variables
2025
base_url = 'http[s]://<example.com>'
2126
token_id = '<token_id>'
22-
token_secret = '<token_secret'>
23-
24-
api = bookstack.BookStack(base_url, token_id=<token_id>, token_secret=<token_secret>)
25-
```
27+
token_secret = '<token_secret>'
2628

27-
## TODO
28-
- Documentation
29-
- Remove `tests` directory from `.gitignore`
29+
api = bookstack.BookStack(base_url, token_id=token_id, token_secret=token_secret)
30+
```

0 commit comments

Comments
 (0)