From 7c1d524f4b8f9c96b65645cd4edbf88706ae4ae7 Mon Sep 17 00:00:00 2001
From: euphoria-laxis <euphoria.laxis@euphoria-laxis.com>
Date: Wed, 24 Jul 2024 23:48:36 +0200
Subject: [PATCH] Add README.md and LICENSE

---
 LICENSE   |  8 ++++++++
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..44ce002
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2022 Euphoria Laxis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..40676a2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# Argon2 utils
+
+## About
+
+Utils to encrypt passwords using argon2
+
+## Usages
+
+### Hash password
+
+````go
+    password := 'qwerty@123'
+    // Create new encoder using default options
+    encoder, _ := argon2.NewEncoder()
+    hashedString, err = encoder.HashString(randomString)
+    if err != nil {
+        // handle error
+    }
+````
+
+### Compare password with hashed string
+
+````go
+    // Create new decoder using default options
+    decoder, _ := argon2.NewDecoder()
+    match, err := decoder.CompareStringToHash(password, hashedString)
+    if err != nil {
+		// handle error
+    }
+````
+
+### Configure encoder or decoder options
+
+Note that encoder and decoder inherited from the same base struct *(argon2.Options)*.
+You can use the same `argon2.OptFunc` slice to configure both encoder and decoder.
+
+````go
+    // Create new encoder using custom parameters
+    encoder, options := argon2.NewEncoder(
+        SetMemory(64 * 1024), // 64 bits
+        SetParallelism(4),    // 4 concurrent actions
+        SetKeyLength(32),     // key length
+        SetSaltLength(32),    // salt length
+        SetIterations(4),     // number of iterations
+    )
+````
+
+## Contributions
+
+**Euphoria Laxis** [GitHub](https://github.com/euphoria-laxis)
+
+## License
+
+This project is under [MIT License](./LICENSE)