We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent a04537b commit 5e943abCopy full SHA for 5e943ab
README.md
@@ -17,18 +17,17 @@ Depending on your OS, you can read those using:
17
```
18
19
# Documentation
20
+
21
+[The documentation is available here](https://aa-alert.github.io/psrdada-python/)
22
See the two scripts in the examples directory, and the tests.
23
24
```python
25
#!/usr/bin/env python3
26
import numpy as np
27
from psrdada import Reader
28
-# Create a reader instace
-reader = Reader()
29
-
30
-# Connect to a running ringbuffer with key 'dada'
31
-reader.connect(0xdada)
+# Create a reader instace and connect to a running ringbuffer with key 'dada'
+reader = Reader(0xdada)
32
33
# loop over the pages
34
for page in reader:
0 commit comments