Update README.md

README.md

@@ -1,8 +1,42 @@
 # py_dockerized_scrypt_hasher
 
- Docker version to expose an API endpoint that hashes to scrypt
+ Docker version to expose a Python (Flask) API endpoint that hashes to scrypt (firebase)
 
+## Setup
+
+1. First, you need some configuration variables from your firebase project, you can get them from firebase->authentication-> little three dots top right of users table
+
+2. create an `.env` file in the project root directory, next to Dockerfile with the below content
+
+    ```bash
+    base64_signer_key='get_from_your_firebase_project'
+    base64_salt_separator='get_from_your_firebase_project'
+    rounds=get_from_your_firebase_project
+    mem_cost=get_from_your_firebase_project
+    ```
+
+3. Next, run the below commands in the project folder (next to Dockerfile)
+
+    ```bash
+    $git clone this repo
+    $cd firebasescrypt
+    $docker build -t firebasescrypt
+    $docker run firebasescrypt
+    ```
+
+Now you have a flask endpoint running at your machine at `http://127.0.0.1:5959` (unless you changed the port or put on a server)
+
+## Usage
+
+Just make sure you have the native password ready and the `salt` used to encrypt it in firebase (not the `salt separator`)
+Example:
+    `http://127.0.0.1/scrypt?string=plain_password&salt=xe3yTfPUs-KyJw==`
+
+## Credits
 
-implements:
 - https://stackoverflow.com/questions/12315398/check-if-a-string-is-encoded-in-base64-using-python
-- https://github.com/JaakkoL/firebase-scrypt-python
+- https://github.com/JaakkoL/firebase-scrypt-python
+
+## Licenses
+
+No licenses, no nothing, just copy and paste all you want