From cdb94126acef82c9274eef57c8945b715fdf0f53 Mon Sep 17 00:00:00 2001
From: Sai Raj <39055732+sairajzero@users.noreply.github.com>
Date: Mon, 26 Jul 2021 15:37:02 +0530
Subject: [PATCH] Create README.md

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..716b033
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+
+# SuperNode Storage
+
+## Installation
+### Pre-requisite
+- [X] Nodejs `version >= 12.9`
+- [X] MySQL Server
+
+### Download
+Download the repository using git:
+```
+git clone https://github.com/ranchimall/SuperNodeStorage.git
+```
+
+### Install
+Install using npm:
+```
+cd SuperNodeStorage
+npm install
+```
+
+### Configuration
+
+#### General Configuration
+Copy `config-sample.json` to `config.json` and Edit the values as required.
+```
+{
+"privateKey": "<private-key>",
+"port": "<port>",
+
+"sql_user": "<MySQL-username>",
+"sql_pwd": "<MySQL-password>",
+"sql_db": "<database-name>",
+"sql_host": "<sql-host>"
+}
+```
+- **private-key**: Private key of the cloud
+- **port**: Port of the server to run on
+- **MySQL-username**: Username for MySQL
+- **MySQL-password**: Password for MySQL
+- **database-name**: Database in which the data should be stored (default: ***supernode***)
+- **sql-host**: Host of the MySQL server (default: ***localhost***).
+
+***Recommended*** *(optional)* Create and use a MySQL user instead of root. Remember to give access to the database to the user.
+
+#### Parameter Generation
+Open `gen-param.html` in a browser and download `param.json` to `SuperNodeStorage` directory.
+
+*Note: param.json is used for controlled random values used by SecureRandom in Cryptography*
+
+## Starting the Server
+After successful installation and configuration using the above steps, SuperNodeStorage can be started using:
+```
+npm start
+```
+
+##
+For more detailed Installation, check the wiki [here](https://github.com/ranchimall/SuperNodeStorage/wiki).