0.3.9 runningMedian

libraries/RunningMedian/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.9] - 2023-11-21
+- update readme.md
+
+
 ## [0.3.8] - 2023-07-11
 - add **getMedianAverage(nMedians)**  removing bias - #22
   - thanks to Peter Kowald
@@ -13,7 +17,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - extended performance test
 - update readme.md
 
-
 ## [0.3.7] - 2022-10-28
 - Add RP2040 support to build-CI.
 - Add CHANGELOG.md

libraries/RunningMedian/README.md

@@ -2,8 +2,11 @@
 [![Arduino CI](https://github.com/RobTillaart/RunningMedian/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/RunningMedian/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/RunningMedian/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/RunningMedian/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/RunningMedian/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/RunningMedian.svg)](https://github.com/RobTillaart/RunningMedian/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/RunningMedian/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/RunningMedian.svg?maxAge=3600)](https://github.com/RobTillaart/RunningMedian/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/RunningMedian.svg)](https://registry.platformio.org/libraries/robtillaart/RunningMedian)
 
 
 # RunningMedian
@@ -71,6 +74,10 @@ There are several options that can be configured via defines at compile time, th
 
 ## Interface
 
+```cpp
+#include "RunningMedian.h"
+```
+
 
 #### Constructor
 
@@ -158,9 +165,25 @@ See examples.
 
 ## Future
 
+#### Must
+
 - improve documentation.
+
+#### Should
+
+#### Could
+
 - check for optimizations.
   - get the median without (full) sorting. QuickSelect()
 - move all code to .cpp file
 
 
+## 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/RunningMedian/RunningMedian.cpp

@@ -1,10 +1,8 @@
 //
 //    FILE: RunningMedian.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.8
+// VERSION: 0.3.9
 // PURPOSE: RunningMedian library for Arduino
-//
-//  HISTORY: see changelog.md
 
 
 #include "RunningMedian.h"
@@ -370,5 +368,6 @@ void RunningMedian::sort()
 }
 */
 
-// -- END OF FILE --
+
+//  -- END OF FILE --
 

libraries/RunningMedian/RunningMedian.h

@@ -3,16 +3,15 @@
 //    FILE: RunningMedian.h
 //  AUTHOR: Rob Tillaart
 // PURPOSE: RunningMedian library for Arduino
-// VERSION: 0.3.8
+// VERSION: 0.3.9
 //     URL: https://github.com/RobTillaart/RunningMedian
 //     URL: http://arduino.cc/playground/Main/RunningMedian
 // HISTORY: See RunningMedian.cpp
-//
 
 
 #include "Arduino.h"
 
-#define RUNNING_MEDIAN_VERSION        (F("0.3.8"))
+#define RUNNING_MEDIAN_VERSION        (F("0.3.9"))
 
 
 //  fall back to fixed storage for dynamic version => remove true
@@ -80,6 +79,7 @@ public:
   uint8_t getCount()   { return _count; };
   bool    isFull()     { return (_count == _size); }
 
+
   //  EXPERIMENTAL  (might change in the future)
   //  searchMode defines how the internal insertionSort works
   //  can be used to optimize performance.
@@ -109,5 +109,5 @@ protected:
 };
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

libraries/RunningMedian/library.json

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

libraries/RunningMedian/library.properties

@@ -1,5 +1,5 @@
 name=RunningMedian
-version=0.3.8
+version=0.3.9
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=The library stores the last N individual values in a buffer to select the median.