Skip to content

Commit

Permalink
update readme.md (#38)
Browse files Browse the repository at this point in the history
- update readme.md (badges)
- fix changelog
  • Loading branch information
RobTillaart authored Oct 19, 2023
1 parent df7f346 commit e899c23
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 8 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# Change Log Complex
# Change Log CRC

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [1.0.2] - 2023-10-19
- update readme.md (badges)
- fix changelog


## [1.0.1] - 2023-07-13
- added headers in examples
- added headers in src
- bumped version number
- update readme.md
- replaced ..._REF_IN ==> ..._REV_IN (OUT iden)


## [1.0.0] - 2023-05-19
- See issue #32 / #31
- new library interface
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
[![Arduino CI](https://github.com/RobTillaart/CRC/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/CRC/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/CRC/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/CRC/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/CRC/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/CRC.svg)](https://github.com/RobTillaart/CRC/issues)

[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/CRC/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/CRC.svg?maxAge=3600)](https://github.com/RobTillaart/CRC/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/CRC.svg)](https://registry.platformio.org/libraries/robtillaart/CRC)


# CRC
Expand Down Expand Up @@ -54,8 +57,15 @@ Deeper tech info

and many other websites.


## Interface CRC classes

```cpp
#include "CRC8.h"
```

#### Base

The interfaces are very similar for CRC8, CRC12, CRC16, CRC32 and CRC64 class.
The difference is the data type for polynome, start- and end-mask,
and the returned CRC.
Expand Down Expand Up @@ -203,3 +213,10 @@ If standard polynomes are missing, please open an issue and report, with referen
user can access parameters, so no need.
## 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,
4 changes: 2 additions & 2 deletions library.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
"type": "git",
"url": "https://github.com/RobTillaart/CRC"
},
"version": "1.0.1",
"version": "1.0.2",
"license": "MIT",
"frameworks": "arduino",
"frameworks": "*",
"platforms": "*",
"headers": "CRC.h"
}
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=CRC
version=1.0.1
version=1.0.2
author=Rob Tillaart <[email protected]>
maintainer=Rob Tillaart <[email protected]>
sentence=Library for CRC for Arduino
Expand Down
2 changes: 1 addition & 1 deletion src/CRC.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//
// FILE: CRC.cpp
// AUTHOR: Rob Tillaart
// VERSION: 1.0.1
// VERSION: 1.0.2
// PURPOSE: Arduino library for CRC8, CRC12, CRC16, CRC32, CRC64
// URL: https://github.com/RobTillaart/CRC

Expand Down
4 changes: 2 additions & 2 deletions src/CRC.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//
// FILE: CRC.h
// AUTHOR: Rob Tillaart
// VERSION: 1.0.1
// VERSION: 1.0.2
// PURPOSE: Arduino library for CRC8, CRC12, CRC16, CRC32, CRC64
// URL: https://github.com/RobTillaart/CRC
//
Expand All @@ -14,7 +14,7 @@
#include "CRC32.h"
#include "CRC64.h"

#define CRC_LIB_VERSION (F("1.0.1"))
#define CRC_LIB_VERSION (F("1.0.2"))


uint8_t calcCRC8(
Expand Down

0 comments on commit e899c23

Please sign in to comment.