Merge pull request #7 from reactos/readme-update

updated Readme

Author: ayushsnha

README.md

@@ -1 +1,29 @@
-# Developer Web Interface for ReactOS (GSOC 2019)
+# Developer Web Interface for ReactOS
+
+## About The Project
+
+---
+
+The Developer Web Interface for ReactOS is a web tool meant to support the development of ReactOS. The main goal of this project is to develop a platform for ReactOS developers to easily track Commits, Builds and Test details. The web Interface makes API calls to various endpoints of GitHub, BuildBot and Testman API and interrelates them and renders a simplified view of Commit, Build and Test details at one place.
+
+### Installation
+
+---
+
+```bash
+git clone https://github.com/reactos/developer-web-interface.git
+npm install
+cd client && npm install
+```
+
+> Create a .env file in root directory and include your GitHub API key ( check config-Env )
+
+### Run Application
+
+---
+
+In the root directory
+
+```bash
+npm run dev
+```

config-Env

@@ -0,0 +1,5 @@
+//sample .env file
+/*create .env file with the fields given below 
+/*when setting up this project on local machine
+
+SECRET=<your github api access token>