From b50e068b43faf66bdbaa57c03514bfd9a976c171 Mon Sep 17 00:00:00 2001 From: Didactic Drunk <1479616+didactic-drunk@users.noreply.github.com> Date: Fri, 28 Jun 2019 13:44:33 -0700 Subject: [PATCH] Documentation. [skip ci] --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 666ec7e..5c75f6b 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,10 @@ Updated Crystal bindings for the [libsodium API](https://libsodium.gitbook.io/do - [x] [Combined mode](https://libsodium.gitbook.io/doc/secret-key_cryptography/authenticated_encryption) - [ ] [Detached mode](https://libsodium.gitbook.io/doc/secret-key_cryptography/authenticated_encryption) - [AEAD](https://libsodium.gitbook.io/doc/secret-key_cryptography/aead) - - [ ] AES256-GCM (Requires hardware acceleration) - - [ ] XChaCha20-Poly1305-IETF - - [ ] ChaCha20-Poly1305-IETF - - [ ] ChaCha20-Poly1305 + - [ ] AES256-GCM (Requires hardware acceleration) + - [ ] XChaCha20-Poly1305-IETF + - [ ] ChaCha20-Poly1305-IETF + - [ ] ChaCha20-Poly1305 - [Hashing](https://libsodium.gitbook.io/doc/hashing) - [x] ☑ [Blake2b](https://libsodium.gitbook.io/doc/hashing/generic_hashing) - [ ] [SipHash](https://libsodium.gitbook.io/doc/hashing/short-input_hashing) @@ -77,10 +77,11 @@ dependencies: | `Cox::Cipher::Chalsa` | What goes with guacamole? | | Everything else | I want to design my own crypto protocol and probably do it wrong. | -The `specs` provide the best examples of how to use or misuse this shard. ## Usage +The `specs` provide the best examples of how to use or misuse this shard. + ### CryptoBox easy encryption ```crystal require "cox"