0.1.2 moduloMap

libraries/moduloMap/CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.1.2] - 2023-11-14
+- update readme.md
+- update keywords.txt
+- minor edits
+
 
 ## [0.1.1] - 2022-10-21
 - add access functions to internal variables.

libraries/moduloMap/README.md

@@ -2,8 +2,11 @@
 [![Arduino CI](https://github.com/RobTillaart/moduloMap/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/moduloMap/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/moduloMap/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/moduloMap/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/moduloMap/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/moduloMap.svg)](https://github.com/RobTillaart/moduloMap/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/moduloMap/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/moduloMap.svg?maxAge=3600)](https://github.com/RobTillaart/moduloMap/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/moduloMap.svg)](https://registry.platformio.org/libraries/robtillaart/moduloMap)
 
 
 # moduloMap
@@ -46,8 +49,23 @@ wheels with known circumference.
 - math fun  
 
 
+#### Related
+
+Other mapping libraries
+
+- https://github.com/RobTillaart/FastMap
+- https://github.com/RobTillaart/Gamma
+- https://github.com/RobTillaart/map2colour
+- https://github.com/RobTillaart/moduloMap
+- https://github.com/RobTillaart/MultiMap
+
+
 ## Interface
 
+```cpp
+#include "moduloMap.h"
+```
+
 - **moduloMap()** constructor.
 - **bool begin(float minimum, float maximum)** define the range the numbers should be mapped to.
 Returns true if minimum < maximum, false otherwise.
@@ -80,24 +98,31 @@ The examples show the basic working of the functions.
 
 ## Future
 
-#### must
+#### Must
 
 - elaborate documentation
 - add examples
 
-#### should
+#### Should
 
 - move code to .cpp file
 
-#### could
+#### Could
 
-- are there other than circular modulos
+- are there other than circular modulo?
   - triangular, square, pentagram, fractal?
   - increasing length per rotation (complex)
-- add link to related libraries
-  - angles + fastmap?
 - add **begin(float radius)**
   - assumes circle from 0..max
 
-#### wont
+#### 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,
 

libraries/moduloMap/examples/moduloMap_demo/moduloMap_demo.ino

@@ -45,9 +45,8 @@ void setup()
 
 void loop()
 {
-
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

libraries/moduloMap/examples/moduloMap_performance/moduloMap_performance.ino

@@ -78,8 +78,7 @@ void setup()
 
 void loop()
 {
-
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --

libraries/moduloMap/examples/moduloMap_rotations/moduloMap_rotations.ino

@@ -65,4 +65,4 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --

libraries/moduloMap/keywords.txt

@@ -6,6 +6,11 @@ moduloMap	KEYWORD1
 
 # Methods and Functions (KEYWORD2)
 begin	KEYWORD2
+
+getMinimum	KEYWORD2
+getMaximum	KEYWORD2
+getRange	KEYWORD2
+
 map	KEYWORD2
 rotations	KEYWORD2
 

libraries/moduloMap/library.json

@@ -15,9 +15,9 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/moduloMap.git"
   },
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "MIT",
-  "frameworks": "arduino",
+  "frameworks": "*",
   "platforms": "*",
   "headers": "moduloMap.h"
 }

libraries/moduloMap/library.properties

@@ -1,5 +1,5 @@
 name=moduloMap
-version=0.1.1
+version=0.1.2
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library for modulo mapping

libraries/moduloMap/moduloMap.h

@@ -2,7 +2,7 @@
 //
 //    FILE: moduloMap.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.1
+// VERSION: 0.1.2
 // PURPOSE: Arduino library for modulo mapping
 //    DATE: 2022-10-15
 //     URL: https://github.com/RobTillaart/moduloMap
@@ -11,7 +11,7 @@
 #include "Arduino.h"
 
 
-#define MODMAP_LIB_VERSION               (F("0.1.1"))
+#define MODMAP_LIB_VERSION               (F("0.1.2"))
 
 
 class MODMAP