From 928c641a26b1cb3950639dde8aba7f63b416b107 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matou=C5=A1=20Dzivjak?= Date: Wed, 9 Oct 2024 09:50:17 +0200 Subject: [PATCH] feat(docs): README note (#59) --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6c54134..f659219 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,17 @@ This package is Go implementation of [ai's](https://github.com/ai) [nanoid](http **Safe.** It uses cryptographically strong random generator. -**Compact.** It uses more symbols than UUID (`A-Za-z0-9_-`) -and has the same number of unique options in just 22 symbols instead of 36. +**Compact.** It uses more symbols than UUID (`A-Za-z0-9_-`) and has the same number of unique options in just 22 symbols instead of 36. **Fast.** Nanoid is as fast as UUID but can be used in URLs. There's also this alternative: https://github.com/jaevor/go-nanoid. +> [!NOTE] +> There's little to no development on this repo, intentionally. It does what it needs to do. Bug reports are welcomed, features _might_ be implemented. +> +> If you are considering more heavy weight solution that integrates with UUIDs (supported by many databases) I would suggest you take a look on [typeid](https://github.com/sumup/typeid) or other equivalents. + ## Install Via go get tool @@ -52,4 +56,4 @@ If you have any issues, just feel free and open it in this repository, thanks! ## License -The MIT License (MIT). Please see [License File](LICENSE.md) for more information. +The MIT License (MIT). Please see [License File](./LICENSE) for more information.