Update README.md

This commit is contained in:
Jordan Wages 2026-07-08 01:20:39 -05:00
commit 40c4faf82b

View file

@ -1,6 +1,6 @@
# CapyKit # CapyKit
CapyKit is a practical .NET utility library for the small pieces of application code that tend to get rewritten from project to project. It includes focused helpers for strings, collections, serialization, compression, password hashing, random value generation, key validation, calculations, resource pooling, and lightweight library diagnostics. [CapyKit](https://capykit.happycapy.net/) is a practical .NET utility library for the small pieces of application code that tend to get rewritten from project to project. It includes focused helpers for strings, collections, serialization, compression, password hashing, random value generation, key validation, calculations, resource pooling, and lightweight library diagnostics.
The project started as shared infrastructure for HappyCapy and is now packaged as a standalone toolkit for .NET 8 applications. The project started as shared infrastructure for HappyCapy and is now packaged as a standalone toolkit for .NET 8 applications.
@ -47,7 +47,7 @@ bool matches = SecurityHelper.CompareHashedPassword(
## Documentation ## Documentation
The in-repository documentation starts at [Docs/index.md](Docs/index.md). It includes an introduction, getting-started guide, and links into the generated DocFX API reference. The documenation for using the library can be viewed online [here](https://capykit.happycapy.net/). [API documenation](https://capykit.happycapy.net/api/CapyKit.html) is also rendered and available.
To build and serve the documentation locally: To build and serve the documentation locally: