aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2022-02-12 16:16:47 +0100
committerMattias Andrée <maandree@kth.se>2022-02-12 16:16:56 +0100
commit3aa9f7176fcb50386967e89653272af7fb7cf3c5 (patch)
tree7bade092a2e263bda67634d03f579578c2c53101 /README
parentMake libar2_latest_argon2_version const (diff)
downloadlibar2-3aa9f7176fcb50386967e89653272af7fb7cf3c5.tar.gz
libar2-3aa9f7176fcb50386967e89653272af7fb7cf3c5.tar.bz2
libar2-3aa9f7176fcb50386967e89653272af7fb7cf3c5.tar.xz
Add man pages, readme, and nonnull attributes and fix documentation typos
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..0072ebd
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+NAME
+ libar2 - Library for the Argon2-family of hashing functions
+
+DESCRIPTION
+ libar2 is a C library that implements the family of Argon2
+ key derivation function, including Argon2d, Argon2i, and
+ Argon2id, as well as Argon2ds which was not part of the
+ submission to the Password Hashing Competition of 2013,
+ which Argon2 won in 2015. As a key derivation function,
+ Argon2 is well-suited for cryptographically hashing
+ (one-way encrypting) passwords.
+
+SEE ALSO
+ crypt(3)