From: Robin Krens <robin@robinkrens.nl>
Date: Thu, 13 Apr 2023 22:09:56 +0000 (+0200)
Subject: readme: update references and pics
X-Git-Url: https://robinkrens.nl/gitweb/?p=libsi24;a=commitdiff_plain;h=0c03d6f1772ca56616ab770ae0ff66925530dfae

readme: update references and pics
---

diff --git a/README.md b/README.md
index 7a5644b..10c696d 100644
--- a/README.md
+++ b/README.md
@@ -4,17 +4,29 @@ 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)``
+You will probably need to include the header and source file to your
+project and glue ``int (*write_and_read)(unsigned char *data, size_t sz)``
 and ``void (*chip_enable)(unsigned val)`` functions to your specific SPI 
-hardware. See examples folders on how to initialze and configure structs.
+HAL vendor calls. 
+
+## Example projects
+Here is a list of example projects that include this library:
+
+- ESP32: https://github.com/robinkrens/libsi24/raw/master/doc/si24r1-pinout.jpg
+
+## Pinout picture
+My chip does not have a silk screen. Luckily it is compatible with 
+the nrf24l01. Here is a picture for reference:
+
+![pinout](https://github.com/robinkrens/libsi24/raw/master/doc/si24r1-pinout.jpg)
 
 ## Currently supported functionality
-- Receiver mode 
-- Transfer mode
-- Dynamic payloads
+- [X] Receiver mode 
+- [X] Transfer mode
+- [X] Dynamic payloads
 
 ## Not supported yet 
-- Multiple channels
+- [ ] Multiple channels
 
 ## References
 - https://datasheet.lcsc.com/szlcsc/1811142211_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.pdf