From d032dfc6d794f26819ced94cf02dd03303f9ae36 Mon Sep 17 00:00:00 2001
From: boyska <boyska@riseup.net>
Date: Mon, 25 Dec 2023 00:40:00 +0100
Subject: [PATCH] readme

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..115e0dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# RDS Encoder library
+
+This repository contains the code for controlling a Pira.cz P164 RDS Encoder.
+Both ethernet and USB are supported.
+
+It can be used both as a library and as a CLI program.
+
+## CLI examples
+
+### Read variable value
+
+```
+sergio --baud 19200 get PS
+ONDAROSS
+```
+
+To make it machine readable, just use `--output json`
+
+```
+sergio --output json --baud 19200 get PS
+{"variable": "PS", "value": "ONDAROSS"}
+```
+
+### Set the radiotext
+
+```
+sergio --baud 19200 set RT1 'www.ondarossa.info'
+```
+
+### Synchronize time and date
+
+This assumes your computer has a correct time and date of course.
+
+```
+sergio --baud 19200 synctime Europe/Rome
+```
+
+You can also specify `--save` so that this is saved immediately.
+
+### Dump everything
+
+```
+sergio --baud 19200 dump > dump.json
+```
+
+
+## Name
+
+Dr. Pira teached us all to [call Sergio](https://www.fumettidellagleba.org/prodotti/scheda/47/11-) whenever
+you have computer problems.