update readme.md (#12)

RobTillaart · Nov 14, 2023 · 22e645c · 22e645c
1 parent 62aab64
commit 22e645c
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 14 deletions.
diff --git a/MultiSpeedI2CScanner.ino b/MultiSpeedI2CScanner.ino
@@ -1,7 +1,7 @@
 //
 //    FILE: MultiSpeedI2CScanner.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.16
+// VERSION: 0.1.17
 // PURPOSE: I2C scanner at different speeds
 //    DATE: 2013-11-05
 //     URL: https://github.com/RobTillaart/MultiSpeedI2CScanner
@@ -393,7 +393,10 @@ void I2Cscan()
   startScan = millis();
   uint8_t count = 0;
 
-  if (disableIRQ) noInterrupts();
+  if (disableIRQ)
+  {
+    noInterrupts();
+  }
 
   if (header)
   {

diff --git a/README.md b/README.md
@@ -1,15 +1,23 @@
 
+
 [![Arduino CI](https://github.com/RobTillaart/MultiSpeedI2CScanner/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/MultiSpeedI2CScanner/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/MultiSpeedI2CScanner/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/MultiSpeedI2CScanner/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/MultiSpeedI2CScanner/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/MultiSpeedI2CScanner.svg)](https://github.com/RobTillaart/MultiSpeedI2CScanner/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/MultiSpeedI2CScanner/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/MultiSpeedI2CScanner.svg?maxAge=3600)](https://github.com/RobTillaart/MultiSpeedI2CScanner/releases)
 
+```
+not used.
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/MultiSpeedI2CScanner.svg)](https://registry.platformio.org/libraries/robtillaart/MultiSpeedI2CScanner)
+```
+
 
 # Arduino MultiSpeed I2C Scanner
 
 
-## Version: 0.1.16
+## Version: 0.1.17
 
 
 ## Description
@@ -116,6 +124,9 @@ Check your datasheet to see which speeds are applicable for the processor in use
 
 #### Must
 
+- update documentation
+- test on RP2040
+
 #### Should
 
 #### Could
@@ -125,3 +136,14 @@ Check your datasheet to see which speeds are applicable for the processor in use
 - rename releaseNotes.md to changelog.md (in line with libraries)
 - I2C GENERIC RESET address 0x00 CMD 0x06
 
+#### Wont
+
+
+## Support
+
+If you appreciate my libraries, you can support the development and maintenance.
+Improve the quality of the libraries by providing issues and Pull Requests, or
+donate through PayPal or GitHub sponsors.
+
+Thank you,
+
diff --git a/examples/MultiSpeedI2CScanner/MultiSpeedI2CScanner.ino b/examples/MultiSpeedI2CScanner/MultiSpeedI2CScanner.ino
@@ -1,7 +1,7 @@
 //
 //    FILE: MultiSpeedI2CScanner.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.16
+// VERSION: 0.1.17
 // PURPOSE: I2C scanner at different speeds
 //    DATE: 2013-11-05
 //     URL: https://github.com/RobTillaart/MultiSpeedI2CScanner
@@ -393,7 +393,10 @@ void I2Cscan()
   startScan = millis();
   uint8_t count = 0;
 
-  if (disableIRQ) noInterrupts();
+  if (disableIRQ)
+  {
+    noInterrupts();
+  }
 
   if (header)
   {

diff --git a/releaseNotes.md b/releaseNotes.md
@@ -1,28 +1,27 @@
 
-# Release Notes
-
-MultiSpeedI2CScanner
+# Release Notes MultiSpeedI2CScanner
 
 https://github.com/RobTillaart/MultiSpeedI2CScanner
 
 
 ## Version 
 
-0.1.16
+0.1.17
+
 
+### 0.1.17  2023-11-14
+- update readme.md
 
 ### 0.1.16  2023-01-20
 
 - update build-ci
 - add link to I2C scanner class in readme.md
 
-
 ### 0.1.15  2021-12-22
 
 - change Khz =>KHz
 - update license
 
-
 ### 0.1.14  2021-11-10
 
 - update Arduino-CI build process
@@ -32,14 +31,12 @@ https://github.com/RobTillaart/MultiSpeedI2CScanner
 - added an I2C bus counter sketch (very minimal)
 - minor edits release notes.
 
-
 ### 0.1.13  2020-12-12
 
 - Add Arduino-CI build process.
 - Added a dummy examples folder with the same .ino source.
 - This shows that the sketch compiles well.
 
-
 ### 0.1.12  2020-12-12
 
 - Fix #4, default address range = 08...119 (0-7 and 120-127 are special)
@@ -91,5 +88,5 @@ note the latter one must adjust the pins in the code.
 (started 2013-11-05 ?)
 
 
-// -- END OF FILE --
+//  -- END OF FILE --