Skip to content

Commit

Permalink
README.md: Prettify.
Browse files Browse the repository at this point in the history
Credit to @ektrah (the maintainer of NSec) for this template.
  • Loading branch information
samuel-lucas6 authored Aug 8, 2022
1 parent 2a34b9d commit ff0af30
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Geralt

[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://github.com/samuel-lucas6/Geralt/blob/main/LICENSE)
[![NuGet](https://img.shields.io/badge/nuget-latest-blue)](https://www.nuget.org/packages/Geralt)

# Geralt
[Geralt](https://www.geralt.xyz/) is a modern cryptographic library for [.NET 6](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) based on [libsodium](https://doc.libsodium.org/) and inspired by [Monocypher](https://monocypher.org/).

- **Simple**: an easy-to-learn API with descriptive naming. Only one primitive for each task is provided when possible.
- **Modern**: the latest and greatest cryptographic primitives, such as (X)ChaCha20-Poly1305, BLAKE2b, Argon2id, X25519, and Ed25519.
- **Secure**: libsodium was [audited](https://www.privateinternetaccess.com/blog/libsodium-audit-results/) in 2017 and is the library of choice for [lots](https://doc.libsodium.org/libsodium_users) of projects and [even](https://doc.libsodium.org/libsodium_users#companies-using-libsodium) large companies.
- **Fast**: libsodium is [faster](https://monocypher.org/speed) than many other cryptographic libraries. Furthermore, Geralt uses [Span<T>](https://docs.microsoft.com/en-us/archive/msdn-magazine/2017/connect/csharp-all-about-span-exploring-a-new-net-mainstay) buffers to avoid memory allocations.

For more information, please view to the following resources:

A modern cryptographic library for [.NET 6](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) based on [libsodium](https://doc.libsodium.org/) and inspired by [Monocypher](https://monocypher.org/).
| | |
|:------------------------- |:------------------------------------------------ |
| Documentation: | https://www.geralt.xyz/ |
| Installation: | https://www.geralt.xyz/#installation |
| Open issues: | https://github.com/samuel-lucas6/Geralt/issues |
| Pull requests: | https://github.com/samuel-lucas6/Geralt/pulls |

0 comments on commit ff0af30

Please # to comment.