From 336fd972c345cad1431fc0b9c542f6afcd043614 Mon Sep 17 00:00:00 2001 From: Rob Tillaart Date: Thu, 2 Nov 2023 15:39:08 +0100 Subject: [PATCH] update readme.md --- GST.cpp | 2 +- GST.h | 4 ++-- README.md | 17 +++++++++++++++-- changelog.md | 5 ++++- library.json | 4 ++-- library.properties | 2 +- 6 files changed, 25 insertions(+), 9 deletions(-) diff --git a/GST.cpp b/GST.cpp index 1bb6f90..980242a 100644 --- a/GST.cpp +++ b/GST.cpp @@ -1,6 +1,6 @@ // // FILE: GST.cpp -// VERSION: 0.1.3 +// VERSION: 0.1.4 // PURPOSE: Arduino library for Gold Standard Test metrics // URL: https://github.com/RobTillaart/GST // https://en.wikipedia.org/wiki/Sensitivity_and_specificity diff --git a/GST.h b/GST.h index 0cf5cc4..9d26349 100644 --- a/GST.h +++ b/GST.h @@ -1,7 +1,7 @@ #pragma once // // FILE: GST.h -// VERSION: 0.1.3 +// VERSION: 0.1.4 // PURPOSE: Arduino library for Gold Standard Test metrics // URL: https://github.com/RobTillaart/GST // https://en.wikipedia.org/wiki/Sensitivity_and_specificity @@ -10,7 +10,7 @@ // formula's based upon Wikipedia. -#define GST_LIB_VERSION (F("0.1.3")) +#define GST_LIB_VERSION (F("0.1.4")) #include "Arduino.h" diff --git a/README.md b/README.md index 51130f5..144a685 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,11 @@ [![Arduino CI](https://github.com/RobTillaart/GST/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci) [![Arduino-lint](https://github.com/RobTillaart/GST/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/GST/actions/workflows/arduino-lint.yml) [![JSON check](https://github.com/RobTillaart/GST/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/GST/actions/workflows/jsoncheck.yml) +[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/GST.svg)](https://github.com/RobTillaart/GST/issues) + [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/GST/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/RobTillaart/GST.svg?maxAge=3600)](https://github.com/RobTillaart/GST/releases) +[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/GST.svg)](https://registry.platformio.org/libraries/robtillaart/GST) # GST @@ -30,6 +33,7 @@ These sites describe the functions in more detail. - https://github.com/RobTillaart/Correlation - https://github.com/RobTillaart/GST - Golden standard test metrics +- https://github.com/RobTillaart/Histogram - https://github.com/RobTillaart/RunningAngle - https://github.com/RobTillaart/RunningAverage - https://github.com/RobTillaart/RunningMedian @@ -158,7 +162,6 @@ Read the Wikipedia pages for their uses. - improve documentation - #### Should - add functions @@ -166,10 +169,20 @@ Read the Wikipedia pages for their uses. - test - complete the CI test coverage. - #### Could - examples - add real life examples. - combination with a sensor? batch testing? +#### 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/changelog.md b/changelog.md index e2b143f..be39871 100644 --- a/changelog.md +++ b/changelog.md @@ -6,13 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## [0.1.4] - 2023-11-02 +- update readme.md + + ## [0.1.3] - 2022-11-08 - update GitHub actions - update license 2023 - update readme.md - update unit tests - ## [0.1.2] - 2022-11-08 - add RP2040 to build CI - update changelog.md diff --git a/library.json b/library.json index 56a52fb..42463a9 100644 --- a/library.json +++ b/library.json @@ -15,9 +15,9 @@ "type": "git", "url": "https://github.com/RobTillaart/GST.git" }, - "version": "0.1.3", + "version": "0.1.4", "license": "MIT", - "frameworks": "arduino", + "frameworks": "*", "platforms": "*", "headers": "GST.h" } diff --git a/library.properties b/library.properties index 16401f8..dfbc1c6 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=GST -version=0.1.3 +version=0.1.4 author=Rob Tillaart maintainer=Rob Tillaart sentence=Arduino library for Golden Standard Test, confusion matrix.