venom: add CHANGELOG

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
virtualtam · Feb 18, 2023 · 59ca61e · 59ca61e
1 parent a978e96
commit 59ca61e
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,23 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/) and this
+project adheres to [Semantic Versioning](https://semver.org/).
+
+## [v1.0.0](https://github.com/virtualtam/venom/releases/tag/v1.0.0) - 2023-02-18
+Initial release.
+
+### Added
+- Allow setting multiple configuration paths for Viper to look for configuration files
+- Run Go linters with golangci-lint
+
+### Changed
+- Refactor project as a package to be used as a library
+- Refactor helper functions
+- Cleanup example code and tests to avoid relying on global variables
+- Bump the minimum Go version to 1.20 (to benefit from the new error helpers)
+- Update documentation
+- Update Github workflow to run linters, and run on tagged versions
+
+### Fixed
+- Handle all errors
diff --git a/README.md b/README.md
@@ -9,6 +9,10 @@ application configuration from:
 - environment variables (`viper`),
 - configuration file(s) (`viper`).
 
+## Change Log
+
+See [CHANGELOG](./CHANGELOG.md).
+
 ## Example
 An example Cobra application can be found under [example/main.go](./example/main.go).