From d6f4f072275f36787917a4c1b7624a672f404aeb Mon Sep 17 00:00:00 2001 From: Alija Bobija Date: Sun, 8 Sep 2024 20:45:45 +0200 Subject: [PATCH] Update readme (#43) --- README.md | 8 ++++++-- idf_component.yml | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d7d1ad43..1435873f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # esp-idf-rc522 -C library for interfacing ESP32 with MFRC522 RFID card reader. +[![Component Registry](https://components.espressif.com/components/abobija/rc522/badge.svg)](https://components.espressif.com/components/abobija/rc522) +C library for interfacing ESP32 with MFRC522 RFID card reader, packaged as ESP-IDF component. + +> [!NOTE] > Library currently just reads serial number of RFID tags, which is enough for most applications. ## How to use @@ -82,7 +85,8 @@ rc522_config_t config = { Let's say that spi bus `VSPI_HOST` has been already initialized, and rc522 needs to be attached to that bus. That can be accomplished with the next configuration. Property `.spi.bus_is_initialized` is required to be set to `true` in order to inform library to not initialize spi bus again. -> NOTE: Property `.spi.bus_is_initialized` will be deprecated in the future once when [this issue](https://github.com/espressif/esp-idf/issues/8745) is resolved. +> [!NOTE] +> Property `.spi.bus_is_initialized` will be deprecated in the future once when [this issue](https://github.com/espressif/esp-idf/issues/8745) is resolved. ```c rc522_config_t config = { diff --git a/idf_component.yml b/idf_component.yml index da6ea6fc..f7793649 100644 --- a/idf_component.yml +++ b/idf_component.yml @@ -1,4 +1,4 @@ -version: "2.6.0" +version: "2.6.1" description: "MFRC522 driver" url: "https://github.com/abobija/esp-idf-rc522" repository: "https://github.com/abobija/esp-idf-rc522.git"