update readme.md

RobTillaart · Nov 22, 2023 · c37c87b · c37c87b
1 parent 692c90c
commit c37c87b
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,14 +5,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [1.0.6] - 2023-11-22
+- update readme.md
+
+
 ## [1.0.5] - 2023-06-29
 - fix #18 add **range()** and **middle()**
   - fast first order functions, based on minimum() and maximum()
   - statistic value is (very) limited.
   - add example.
 - update readme.md
 
-
 ## [1.0.4] - 2023-05-09
 - fix #16 => defined(__AVR__) to catch all ARCH_AVR
 

diff --git a/README.md b/README.md
@@ -1,9 +1,12 @@
 
 [![Arduino CI](https://github.com/RobTillaart/Statistic/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/Statistic/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/Statistic/actions/workflows/arduino-lint.yml)
-[![Arduino-lint](https://github.com/RobTillaart/Statistic/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/Statistic/actions/workflows/arduino-lint.yml)
+[![JSON check](https://github.com/RobTillaart/Statistic/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/Statistic/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/Statistic.svg)](https://github.com/RobTillaart/Statistic/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/Statistic/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/Statistic.svg?maxAge=3600)](https://github.com/RobTillaart/Statistic/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/Statistic.svg)](https://registry.platformio.org/libraries/robtillaart/Statistic)
 
 
 # Statistic
@@ -154,3 +157,13 @@ See https://github.com/RobTillaart/Statistic/blob/master/FAQ.md
   - should these be NaN, which is technically more correct?
   - does it exist for all value types? => No!
   - user responsibility to check **count()** first.
+
+
+## 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/Statistic.h b/Statistic.h
@@ -4,7 +4,7 @@
 //  AUTHOR: Rob Tillaart
 //          modified at 0.3 by Gil Ross at physics dot org
 //          template version 1.0.0 by Glen Cornell
-// VERSION: 1.0.5
+// VERSION: 1.0.6
 // PURPOSE: Recursive Statistical library for Arduino
 // HISTORY: See CHANGELOG.md
 //
@@ -37,7 +37,7 @@
 // and HAVE_STDCXX_CSTDINT feature macros in your build environment.
 
 
-#define STATISTIC_LIB_VERSION                     (F("1.0.5"))
+#define STATISTIC_LIB_VERSION                     (F("1.0.6"))
 
 
 #if defined(__AVR__)

diff --git a/examples/statistic_test/statistic_test.ino b/examples/statistic_test/statistic_test.ino
@@ -0,0 +1,49 @@
+//
+//    FILE: statistic_test.ino
+//  AUTHOR: Rob Tillaart
+// PURPOSE: test sketch
+
+
+#include "Statistic.h"
+
+statistic::Statistic<float, uint32_t, true> myStats;
+// Statistic myStats;  // pre 1.0.0 declaration
+
+
+void setup(void)
+{
+  Serial.begin(115200);
+  Serial.println(__FILE__);
+  Serial.print("Demo Statistics lib ");
+  Serial.println(STATISTIC_LIB_VERSION);
+
+  myStats.clear();  //  explicitly start clean
+
+
+  for (int i = 0; i < 10; i++)
+  {
+    myStats.add(i * 0.01 + 1);  //  add 10 elements
+  }
+//  Serial.print("        Count: ");
+//  Serial.println(myStats.count());
+//  Serial.print("          Min: ");
+//  Serial.println(myStats.minimum(), 4);
+//  Serial.print("          Max: ");
+//  Serial.println(myStats.maximum(), 4);
+//  Serial.print("      Average: ");
+//  Serial.println(myStats.average(), 4);
+//  Serial.print("     variance: ");
+//  Serial.println(myStats.variance(), 4);
+  Serial.print("    pop stdev: ");
+  Serial.println(myStats.pop_stdev(), 4);
+  Serial.print(" unbias stdev: ");
+  Serial.println(myStats.unbiased_stdev(), 4);
+}
+
+
+void loop(void)
+{
+}
+
+
+//  -- END OF FILE --
diff --git a/keywords.txt b/keywords.txt
@@ -18,6 +18,9 @@ variance	KEYWORD2
 pop_stdev	KEYWORD2
 unbiased_stdev	KEYWORD2
 
+range	KEYWORD2
+middle	KEYWORD2
+
 
 # Instances (KEYWORD2)
 

diff --git a/library.json b/library.json
@@ -21,9 +21,9 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/Statistic.git"
   },
-  "version": "1.0.5",
+  "version": "1.0.6",
   "license": "MIT",
-  "frameworks": "arduino",
+  "frameworks": "*",
   "platforms": "*",
   "headers": "Statistic.h"
 }
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=Statistic
-version=1.0.5
+version=1.0.6
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Library with basic statistical functions for Arduino.