From e6773f71efbb90536539845124f158d54dd4b3be Mon Sep 17 00:00:00 2001
From: Jens True <jens.chr.true@gmail.com>
Date: Mon, 1 Nov 2021 09:55:09 +0000
Subject: [PATCH] Added readme

---
 README | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..e42113e
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+# MAX7456JSON
+
+MAX7456JSON is an Arduino project for generating TUI interfaces on weird old school devices.
+
+## Build
+
+Use PlatFormIO [PlatformIO](https://platformio.org/) to build the project.
+
+```bash
+pip install platformio
+git clone https://code.jcktrue.dk/jct/MAX7456JSON
+pio run -t upload
+```
+
+## Usage
+
+Send JSON commands over the serial port
+
+```json
+{"command":"write","x":1,"y":2,"text":"testing"}
+```
+
+# Documentation
+
+Low level API documentation is auto generated and pushed to 
+[API docs](https://share.jcktrue.dk/MAX7456JSON/dev/docs/)
+
+# Download
+Ready made firmware images can be downloaded as HEX files.
+
+- [Unstable](https://share.jcktrue.dk/MAX7456JSON/dev/)
+- [Releases](https://share.jcktrue.dk/MAX7456JSON/)
+
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)
\ No newline at end of file