Skip to content

Commit

Permalink
sorting out nuokg readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pblasucci committed Aug 20, 2023
1 parent 6f52ffe commit 08d1bad
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
21 changes: 21 additions & 0 deletions ananoid/README.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion ananoid/ananoid.fsproj
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
</ItemGroup>
<ItemGroup>
<None Include="assets\ananoid.png" Pack="true" PackagePath="\"/>
<None Include="..\README.md" Pack="true" PackagePath="\"/>
<None Include="README.md" Pack="true" PackagePath="\"/>
</ItemGroup>
<ItemGroup>
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
Expand Down

0 comments on commit 08d1bad

Please sign in to comment.