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

Commit d6bef6f

Browse files
committed
Added Installation and Usage to README.md
1 parent cb24d6d commit d6bef6f

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# bookstack
2+
version: 0.1.0-alpha.2
3+
24
A Python wrapper for [BookStack's](https://www.bookstackapp.com) API
35

4-
- TODO document examples
6+
# Installation
7+
To install `bookstack`, run:
8+
9+
`pip install bookstack`
10+
11+
# Usage
12+
To use BookStack's API, you'll need to get a token ID and secret.
13+
14+
You can find how to get these values from your BookStack instance's doc page at `http[s]://<example.com>/api/docs`
15+
16+
```python
17+
import bookstack
18+
19+
# Input the appropriate values for these three variables
20+
base_url = 'http[s]://<example.com>'
21+
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+
```
26+
27+
## TODO
28+
- Documentation
529
- Remove `tests` directory from `.gitignore`

0 commit comments

Comments
 (0)