Skip to content

Commit 15d5f43

Browse files
authored
add more info to readme
1 parent 857af67 commit 15d5f43

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,26 @@
1313
`qbreader` is a Python wrapper to the qbreader API as well as a general quizbowl library. It provides
1414
both asynchronous and synchronous interfaces to the API along with functionality for representing questions.
1515

16-
## Tossup Example
16+
Documentation for this package is available at <https://python-qbreader.readthedocs.io/>.
17+
18+
## Installation
19+
20+
### PyPI
21+
22+
```sh
23+
$ pip install qbreader
24+
# or whatever environment/dependency management system you use
25+
```
26+
27+
### Git
28+
29+
Alternatively, you may install the most recent, but potentially unstable, development version directly from this repository.
30+
31+
```sh
32+
$ pip install git+https://github.com/qbreader/python-module.git
33+
```
34+
35+
## A quick glance
1736

1837
```py
1938
>>> from qbreader import Sync as qbr # synchronous interface
@@ -37,11 +56,6 @@ both asynchronous and synchronous interfaces to the API along with functionality
3756
'2022 Prison Bowl'
3857
>>> (tossup.packet.number, tossup.number)
3958
(4, 20)
40-
```
41-
42-
## Bonus Example
43-
44-
```py
4559
>>> bonus = sync_client.random_bonus()[0]
4660
>>> bonus.leadin
4761
'The Curry–Howard isomorphism states that computer programs are directly equivalent to these mathematical constructs, which can be automated using the languages Lean or Rocq (“rock”). For 10 points each:'

0 commit comments

Comments
 (0)