From cce94deba11576342b9ac111e1c41dc6203a7195 Mon Sep 17 00:00:00 2001
From: Vinzenz Schroeter <vinzenz.f.s@gmail.com>
Date: Sat, 8 Feb 2025 14:17:20 +0100
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..814eaec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# servicepoint-cli
+
+This repository contains a command line interface for the ServicePoint display.
+
+To send commands, this uses the [servicepoint crate](https://crates.io/crates/servicepoint).
+
+## Running
+
+Any OS:
+```shell
+git clone https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git
+cd servicepoint-cli
+cargo run -- <args>
+```
+
+Using nix:
+
+```shell
+# from CCCB Forgejo
+nix run git+https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git -- <args>
+
+# from GitHub mirror
+nix run github:kaesaecracker/servicepoint-cli -- <args>
+```
+
+## Contributing
+
+If you have ideas on how to improve the code, add features or improve documentation feel free to open a pull request.
+
+You think you found a bug? Please open an issue.
+
+Submissions on Forgejo are preferred, but you can also use GitHub. 
+
+All creatures welcome.
+
+## License
+
+This code is licensed under [GNU General Public License v3.0 or later](https://www.gnu.org/licenses/gpl-3.0-standalone.html).