Compare commits

...

4 commits

Author SHA1 Message Date
506e92f17a 🔀 Merge tag 'v1.0.0' into develop
🚀 Stable release
2025-03-31 15:57:06 -05:00
4e3132a5cf 🔀 Merge branch 'release/1.0.0' into stable 2025-03-31 15:56:49 -05:00
2561fe3cff 📝 Update CHANGELOG 2025-03-31 15:56:34 -05:00
17961ddd41 📝 Add one more link to README 2025-03-31 15:52:10 -05:00
2 changed files with 16 additions and 3 deletions

View file

@ -1,5 +1,20 @@
# 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

View file

@ -4,8 +4,6 @@ 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
@ -75,7 +73,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][].
[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.
[docs]: https://pkg.go.dev/codeberg.org/danjones000/nomino
[examples]: https://pkg.go.dev/codeberg.org/danjones000/nomino#pkg-examples