From: Robin Krens <robin@robinkrens.nl>
Date: Mon, 23 Jan 2023 15:47:00 +0000 (+0100)
Subject: readme: added initial readme
X-Git-Url: https://robinkrens.nl/gitweb/?a=commitdiff_plain;h=ec71522443ce226a118003f98273a8aad1ab98af;p=libsi24

readme: added initial readme
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3798fc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Library for SI24R1
+SI24R1 is a very low power wireless chip in the 2.4 GHz ISM radio band.
+This is a clone of the original NRF24l01 chip. I do not have the
+original chip, but as far as I can tell this are pin and silicon compatible.
+
+## How to use
+You will need to glue ``int (*write_and_read)(unsigned char *data, size_t sz)``
+and ``void (*chip_enable)(unsigned val)`` functions to your specific SPI 
+hardware
+
+## Currently supported functionality
+- Receiver mode 
+- Transfer mode
+
+## Not supported yet 
+- Multiple channels
+- Dynamic payload 
+
+## References
+- https://datasheet.lcsc.com/szlcsc/1811142211_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.pdf