diff --git a/CHANGELOG.md b/CHANGELOG.md index 9020008..5ec72e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,20 +1,5 @@ # Changelog -### [1.0.0] - 2025-03-31 - 🚀 Stable release! - -#### Support - -- 📝 Vastly improved [go docs](https://pkg.go.dev/codeberg.org/danjones000/nomino). -- 📝 Fill out README with examples and links. - -#### Tools - -- 🛠 Replace all linting with golangci-lint - -#### Code quality - -- 🚨 A bunch of small improvements from new linter - ### [0.5.0] - 2025-03-19 - ✨ Different types of UUIDs #### Features diff --git a/README.md b/README.md index e0b3f51..96bc19a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ The purpose of nomino is to generate (probably random) filenames, for example, i It takes a lot of inspiration (although no actual code) from [Onym](https://github.com/Blaspsoft/onym). +Note that this is still not at a stable release. There will be breaking changes between minor releases until it reaches 1.0.0. Patch releases shouldn't contain breaking changes however. Once it reaches 1.0.0, breaking changes will only happen between major releases. + Make sure to check out the [official documentation][docs]. ## Installation @@ -73,7 +75,7 @@ Finally, you can create a [custom generator](https://pkg.go.dev/codeberg.org/dan ## RTFM (Read the fabulous manual) -[Official docs][docs], especially the [examples][]. Especially check out the [full example](https://pkg.go.dev/codeberg.org/danjones000/nomino#example-package), which includes how to use a global configuration. +[Official docs][docs], especially the [examples][]. [docs]: https://pkg.go.dev/codeberg.org/danjones000/nomino [examples]: https://pkg.go.dev/codeberg.org/danjones000/nomino#pkg-examples