From 08d1bad1d24ae5db0eaf8049e6a388f0ceaaa4b5 Mon Sep 17 00:00:00 2001 From: Paul Blasucci Date: Mon, 21 Aug 2023 00:34:23 +0200 Subject: [PATCH] sorting out nuokg readme --- README.md | 4 ++-- ananoid/README.md | 21 +++++++++++++++++++++ ananoid/ananoid.fsproj | 2 +- 3 files changed, 24 insertions(+), 3 deletions(-) create mode 100644 ananoid/README.md diff --git a/README.md b/README.md index 1be9084..6995203 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,6 @@ For more information see the project's [License][0] file. [1]: https://github.com/ai/nanoid [2]: https://www.nuget.org/packages/pblasucci.ananoid [3]: https://dotnet.microsoft.com/en-us/download/dotnet/7.0 -[4]: https://paul.blasuc.ci/ananoid/guides/nanoiddefault.html -[5]: https://paul.blasuc.ci/ananoid/reference/pblasucci-ananoid.html +[4]: https://pblasucci.github.io/ananoid/guides/nanoiddefault.html +[5]: https://pblasucci.github.io/ananoid/reference/pblasucci-ananoid.html [6]: https://github.com/pblasucci/ananoid/blob/main/CHANGELOG.md diff --git a/ananoid/README.md b/ananoid/README.md new file mode 100644 index 0000000..1815423 --- /dev/null +++ b/ananoid/README.md @@ -0,0 +1,21 @@ +Ananoid +=== + +Ananoid provides nano identifiers, an alternative to UUIDs. This project was +inspired by https://github.com/ai/nanoid. + +### Overview + +A nano identifier, or nanoid, is a randomly generated opaque value, suitable +for uniquely identifying database entries, file names, et cetera. + +Ananoid (pronounced: "an-an-oyd") is a library for generating such identifiers. +It uses cryptographically secure random number generation, and has no +dependencies beyond the dotnet 6 base class libraries. It has both a high-level +API, and a simpler, more memory-efficient, low-level API. + +### Recommended Reading + +- Getting Started... https://pblasucci.github.io/ananoid/guides/nanoiddefault.html +- API Documentation... https://pblasucci.github.io/ananoid/reference/pblasucci-ananoid.html +- CHANGELOG... https://github.com/pblasucci/ananoid/blob/main/CHANGELOG.md diff --git a/ananoid/ananoid.fsproj b/ananoid/ananoid.fsproj index 33f23cf..8ffa8d0 100644 --- a/ananoid/ananoid.fsproj +++ b/ananoid/ananoid.fsproj @@ -36,7 +36,7 @@ - +