docs: add readme and license

Author: Techie-Pi

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022
+
+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.

README.md

@@ -0,0 +1,54 @@
+# Firebase Scrypt (for Rust)
+
+Pure Rust implementation of [Firebase's script](https://github.com/firebase/scrypt) password hashing algorithm.
+
+## Installation
+Add this to your ``Cargo.toml``
+
+```toml
+[dependencies]
+firebase-scrypt = "0.1"
+```
+
+## Usage
+With the ``simple`` feature:
+```rust
+use firebase_scrypt::FirebaseScrypt;
+
+const SALT_SEPARATOR: &str = "Bw==";
+const SIGNER_KEY: &str = "jxspr8Ki0RYycVU8zykbdLGjFQ3McFUH0uiiTvC8pVMXAn210wjLNmdZJzxUECKbm0QsEmYUSDzZvpjeJ9WmXA==";
+const ROUNDS: u32 = 8;
+const MEM_COST: u32 = 14;
+
+let firebase_scrypt = FirebaseScrypt::new(SALT_SEPARATOR, SIGNER_KEY, ROUNDS, MEM_COST);
+
+let password = "user1password";
+let salt = "42xEC+ixf3L2lw==";
+let password_hash ="lSrfV15cpx95/sZS2W9c9Kp6i/LVgQNDNC/qzrCnh1SAyZvqmZqAjTdn3aoItz+VHjoZilo78198JAdRuid5lQ==";
+
+assert!(firebase_scrypt.verify_password(password, salt, password_hash).unwrap())
+```
+
+Use the ``verify_password`` function without ``FirebaseScrypt``
+```rust
+use firebase_scrypt::verify_password;
+
+const SALT_SEPARATOR: &str = "Bw==";
+const SIGNER_KEY: &str = "jxspr8Ki0RYycVU8zykbdLGjFQ3McFUH0uiiTvC8pVMXAn210wjLNmdZJzxUECKbm0QsEmYUSDzZvpjeJ9WmXA==";
+const ROUNDS: u32 = 8;
+const MEM_COST: u32 = 14;
+
+let password = "user1password";
+let salt = "42xEC+ixf3L2lw==";
+let password_hash ="lSrfV15cpx95/sZS2W9c9Kp6i/LVgQNDNC/qzrCnh1SAyZvqmZqAjTdn3aoItz+VHjoZilo78198JAdRuid5lQ==";
+
+let is_valid = verify_password(
+     password,
+     password_hash,
+     salt,
+     SALT_SEPARATOR,
+     SIGNER_KEY,
+     ROUNDS,
+     MEM_COST,
+).unwrap();
+```