Added botan-low minimal README

haskell-cryptography · Feb 5, 2024 · c335520 · c335520
1 parent 339eb34
commit c335520
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 7 deletions.
diff --git a/botan-low/README.md b/botan-low/README.md
@@ -1,8 +1,7 @@
-# botan-low
+# Welcome to botan-low
 
-Low-level bindings with imperative IO and exceptions.
+Low-level bindings to the [Botan](https://botan.randombit.net/) cryptography library.
 
-- Type aliases
-- Friendlier patterns
-- Safely wraps buffers and pointers into bytestrings
-- Autoreleased objects
+> Botan's goal is to be the best option for cryptography in C++ by offering the tools necessary to implement a range of practical systems, such as TLS protocol, X.509 certificates, modern AEAD ciphers, PKCS#11 and TPM hardware support, password hashing, and post quantum crypto schemes.
+
+For more information, see the [README on Github](https://github.com/apotheca/botan)
diff --git a/botan-low/botan-low.cabal b/botan-low/botan-low.cabal
@@ -8,7 +8,17 @@ build-type:     Simple
 category:       Cryptography
 synopsis:       Low-level Botan bindings
 description:
-    Low-level bindings to the Botan cryptography library
+
+    Welcome to botan-low
+
+    Low-level bindings to the [Botan](https://botan.randombit.net/) cryptography library.
+
+    > Botan's goal is to be the best option for cryptography in C++ by offering the
+    > tools necessary to implement a range of practical systems, such as TLS protocol,
+    > X.509 certificates, modern AEAD ciphers, PKCS#11 and TPM hardware support,
+    > password hashing, and post quantum crypto schemes.
+
+    For more information, see the [README on Github](https://github.com/apotheca/botan)
 
 -- NOTE: Use data-files instead, if this is inappropriate
 -- NOTE: This causes a soft error: