aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index e3e98cb..690fdd2 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,24 @@
Python program that fetches (Swiss) teletext from `api.teletext.ch` and displays
it in the terminal using curses.
+## Usage
+
+- `c`: switch channel (srf1, srfzwei, srfinfo)
+- `<number><return>`: got to page
+- `h`/`l` go to prev/next page
+- `r` reload page
+- `q` quit
+
+## Limitations
+
+- Graphics are not rendered.
+- Sometimes text is misaligned.
+
+## Example
+
+![example](./res/example.png)
+
+
+
+