From 17961ddd41ec8259b11fc3af4d4bea8da03a38c7 Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Mon, 31 Mar 2025 15:52:10 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20one=20more=20link=20to=20R?= =?UTF-8?q?EADME?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 96bc19a..e0b3f51 100644 --- a/README.md +++ b/README.md @@ -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