reset versioning - origin of releases

Author: Justin C Presley

README.md

@@ -26,6 +26,10 @@ The full API documentation is available on [pkg.go.dev](https://pkg.go.dev/githu
 
 Additionally, [usage](https://github.com/justincpresley/go-cobs/blob/master/docs/USAGE.md) outlines everything you need to know about types, config, and anything that may be unclear outside of the API.
 
+## Notes
+
+***go-cobs*** stands out from other COBS libraries due to [many differences](https://github.com/justincpresley/go-cobs/blob/master/docs/DIFFERENCES.md). This library has discovered advances in the COBS that are not stated anywhere else.
+
 ## License
 
 ***go-cobs*** is an open source project licensed under ISC. See LICENSE.md for more information.
@@ -35,5 +39,5 @@ Additionally, [usage](https://github.com/justincpresley/go-cobs/blob/master/docs
 [3]: https://www.codefactor.io/repository/github/justincpresley/go-cobs
 [4]: https://go.dev/
 [5]: https://github.com/justincpresley/go-cobs/releases
-[6]: https://github.com/justincpresley/go-cobs/compare/v1.5.0-alpha.1...HEAD
+[6]: https://github.com/justincpresley/go-cobs/compare/v1.6.0...HEAD
 [7]: https://en.wikipedia.org/wiki/ISC_license

docs/CHANGELOG.md

@@ -4,17 +4,18 @@ All notable changes to **go-cobs** will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Go's Versioning](https://go.dev/doc/modules/release-workflow).
 
-This Changelog starts at ***v1.5.0-alpha.1*** due to the late integration of this log.
+This Changelog starts at ***v1.6.0*** due to the late integration of this log.
 
 ## [Unreleased]
 
-## [v1.5.0-alpha.1] - 2024-02-18
+## [v1.6.0] - 2024-02-18
 ## Added
 - An easy-to-run example which can be run instantly after cloning this repository.
+- A Changelog!
 
 ## Changed
-- Completely refactor the structure of this library.
+- Completely refactor the structure and documentation of this library.
 - Moved to go 1.22, updated all dependencies.
 
-[Unreleased]: https://github.com/justincpresley/go-cobs/compare/v1.5.0-alpha.1...HEAD
-[v1.5.0-alpha.1]: https://github.com/justincpresley/go-cobs/releases/tag/v1.5.0-alpha.1
+[Unreleased]: https://github.com/justincpresley/go-cobs/compare/v1.6.0...HEAD
+[v1.6.0]: https://github.com/justincpresley/go-cobs/releases/tag/v1.6.0

docs/DIFFERENCES.md

@@ -0,0 +1,15 @@
+# Differences
+
+Comparatively, this library offers combined functionality not found within most if not all other COBS libraries on the market as of writing this. To name a few:
+
+ - **Choose whether the Delimiter (Special byte) is added.** Libraries tend to choose this for you.
+ - **Choose what the Special Byte is.** Libraries tend to provide the NULL (0x00) byte only.
+ - **Use COBS as a Layer of Integrity.** By ensuring that the special byte does not occur (expect with a delimiter) and by ensuring that the flags lead to the end of the data, COBS can provide a small layer of integrity.
+ - **Use a TONS of different extensions (types).** Found in [usage](https://github.com/justincpresley/go-cobs/blob/master/docs/USAGE.md), rare types are included and even ones only included in this library.
+ - **Additional API Commands.** Not only is there functions to calculate the min/max overhead for COBS but also flag-related functions.
+
+## Research
+
+There is a lot of research potential out of this library. For example, It would be an interesting to find what the optimal amount of flags is to provide the best integrity checking for some given data.
+
+The license on **go-cobs** was chosen to help facilitate research. If you do conduct research, you are welcomed to open an [Issue](https://github.com/justincpresley/go-cobs/issues) to document your findings/papers/etc. This way, **go-cobs** can take in your research (given the approach attributions) and grow as a library.

flags.go

@@ -2,7 +2,7 @@ package cobs
 
 const (
 	Branch  = "master"
-	Version = "v1.5.0-alpha.1"
+	Version = "v1.6.0"
 	License = "ISC License"
 	Source  = "github.com/justincpresley/go-cobs"
 	Created = "2022-07-24"