From 11db6b46e69b34c4ce8772978d9cf7b273ce0935 Mon Sep 17 00:00:00 2001
From: Rajnish Mishra <contact.rajnishmishra@gmail.com>
Date: Wed, 12 May 2021 23:13:43 +0530
Subject: [PATCH] Updated README.md

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 765da25..454b2fe 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,30 @@
 # Lupt Chat
 Chat app to talk in group or to strangers
 
-export SALT as environment variable to use as salt for hashing.
+## Running
+Export SALT as environment variable to use as salt for hashing, and TENOR_API_KEY for gifs support in the server.
+
+```
+SALT="<salt>" TENOR_API_KEY="API-KEY" lupt --bind_address <interface address>:<port> --static_path <static files dir>
+```
+
+Example:
+
+```
+SALT="sometext" TENOR_API_KEY="API-KEY" lupt --bind_address 0.0.0.0:8080 --static_path ./static
+```
+
+## Building
+
+Make sure the rust toolchain is installed. (If not, install using [rustup.rs](https://rustup.rs/))
+Then, just use cargo to build the project binary
+
+```
+cargo build --release
+```
+
+This will produce the required project binary `lupt` in `target/release/lupt`
+
+## License
+
+This project is under (GPL License)(LICENSE)