Skip to content

Commit 5e943ab

Browse files
author
Jisk Attema
committed
Add link to docs
1 parent a04537b commit 5e943ab

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,17 @@ Depending on your OS, you can read those using:
1717
```
1818

1919
# Documentation
20+
21+
[The documentation is available here](https://aa-alert.github.io/psrdada-python/)
2022
See the two scripts in the examples directory, and the tests.
2123

2224
```python
2325
#!/usr/bin/env python3
2426
import numpy as np
2527
from psrdada import Reader
2628

27-
# Create a reader instace
28-
reader = Reader()
29-
30-
# Connect to a running ringbuffer with key 'dada'
31-
reader.connect(0xdada)
29+
# Create a reader instace and connect to a running ringbuffer with key 'dada'
30+
reader = Reader(0xdada)
3231

3332
# loop over the pages
3433
for page in reader:

0 commit comments

Comments
 (0)