Added documentation about the project.

Author: SlapBot

LICENSE

@@ -1,76 +1,213 @@
-**Note**: React and Electron were setup following this guide: 
-1. [Github](https://github.com/willjw3/react-electron/blob/master/package.json)
-2. [Youtube](https://www.youtube.com/watch?v=Cdu2O6o2DCg)
+<br />
+<p align="center">
+  <a href="https://powir.slapbot.me">
+    <img src="public/icon.ico" alt="Logo" width="80" height="80">
+  </a>
+  <h3 align="center">Powir</h3>
+  <p align="center">
+    Windows 10 based tool to monitor and analyze your system's power and battery usage
+    <br />
+    <a href="https://powir.slapbot.me"><strong>Explore the website »</strong></a>
+    <br />
+    <br />
+    <a href="https://join.slack.com/t/powir/shared_invite/zt-ezy7sf5d-Tt1MmP_bcf_gdGLEJSEfzw">Join Slack</a>
+    ·
+    <a href="https://github.com/slapbot/powir/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/slapbot/powir/issues">Request Feature</a>
+    ·
+    <a href="https://twitter.com/ugupta41">Give Feedback</a>
+  </p>
+</p>
 
-Give credits:
-1. <a href="https://icons8.com/icon/64452/heart">Heart icon by Icons8</a>
+<hr>
 
----
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+![](demos/gifs/powir-main.gif)
 
-## Available Scripts
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
 
-In the project directory, you can run:
+* [About the Project](#about-the-project)
+  * [What is it?](#what-is-it)
+  * [Installation](#installation)
+* [Features](#features)
+  * [What it does?](#what-it-does)
+  * [Why build it?](#why-build-it)
+  * [Actions?](#actions)
+* [Gallery](#gallery)
+  * [Battery Information](#battery-information)
+  * [System Information](#system-information)
+  * [Power & Battery Usage](#power-battery-usage)
+* [Installation](#installation)
+* [FAQs](#faqs)
+* [Developer](#developer)
+  * [Prerequisites](#prerequisites)
+  * [Setup](#setup)
+  * [Build](#build)
+  * [Usage](#usage)
+* [Contributing](#contributing)
+* [License](#license)
+* [Contact](#contact)
+* [Acknowledgement](#acknowledgement)
 
-### `yarn start`
+<hr>
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## About The Project
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+### What is it?
 
-### `yarn test`
+Powir is a Windows 10 based tool to monitor and analyze your system's power and battery usage.
 
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+It provides you with various information and statistics about the current and overall history of the power and battery usage of your system.
 
-### `yarn build`
+### Installation
 
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the best performance.
+Installation is as quick as simply downloading the executable and running it. 
+The App is completely portable meaning you don't have to go through an installation wizard, 
+and it can be copied from system to system seamlessly.
 
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
+Simply go to [Releases](https://github.com/SlapBot/powir/releases) and pick the latest version to download.
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
 
-### `yarn eject`
+## Features
+![](demos/processed-screenshots/about.png)
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+### What it does?
+- Provides you with a simple and clean UI to list your battery and system information.
+- Shows you the change in battery capacity since the OS was installed.
+- Analyzes the current and overall estimated battery life of your system.
+- Computes various statistics to give a better understanding of your power usage.
+- Ability to export all the data via various formats: PDF (app), JSON (processed), HTML (original report).
+- 100% free and completely open-source for an absolute transparency.
+- Completely portable app with no installation required, ready to use out of the box.
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+### Why build it?
+- Complete lack of any such power/battery monitoring analyzing tool available in the market.
+- Obscure documentation over how to find battery statuses on the Internet.
+- Required to use terminal in order to run a command showing information about the system.
+- Devoid of any simple and understandable metrics from the underlying API or report.
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
 
-## Learn More
+### Actions
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+![](demos/processed-screenshots/actions.png)
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+- Export the current report of your system from Powir in PDF format
+- Export the parsed and processed data of your system from Powir in JSON format
+- Shows original report generated by Windows using the command:powercfg /batteryreport in the terminal
 
-### Code Splitting
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
 
-### Analyzing the Bundle Size
+## Gallery
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+### Battery Information
 
-### Making a Progressive Web App
+![](demos/processed-screenshots/battery-information.png)
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
 
-### Advanced Configuration
+### System Information
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+![](demos/processed-screenshots/system-information.png)
 
-### Deployment
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+### Power & Battery Usage
 
-### `yarn build` fails to minify
+![](demos/processed-screenshots/recent-usage.png)
 
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+
+## FAQs
+
+![](demos/processed-screenshots/FAQs.png)
+
+<strong>Is it completely free?</strong>
+
+Yes, Powir is 100% free to download and use.
+
+<strong>Are the numbers displayed 100% correct?</strong>
+
+Depends, Powir parses the raw reports generated from Windows and does the computations of the various statistics and render the charts.
+
+<strong>What tooling was used to build the app?</strong>
+
+Powir runs as an electron app (chromium web engine embedded) while using React to facilitate the UI and data workflow.
+
+<strong>Does it share my data anywhere?</strong>
+
+No, Powir will never share your data anywhere outside your local system, the entire source code of the app is online for anyone to check. Infact, it never makes any request to a server since there is none. Its simply a client sided app.
+
+<hr>
+
+## Developer
+If you're looking to build it from the source or inspect the app, its extremely simply and you only have to follow few instructions as listed below:
+
+### Prerequisites
+- Node
+- NPM
+
+### Setup
+
+- Clone the repository: `git clone https://github.com/SlapBot/powir.git`
+- Cd into the directory: `cd powir` and run: `npm install`
+
+### Build
+
+- Run `npm run build` which will package the app at `dist/` folder.
+
+### Usage
+
+- Run these two commands in two separate sessions when you are developing in order to use HMR (hot module reloading):
+    - Run react server: `npm run react-start`
+    - Run electron app: `npm run electron-start`
+- All of the server code is located at: `public/server` directory.
+- Entrypoint of the electron app is at`public/electron.js`.
+- Everything related to rendering is done at: `src` directory.
+- Any of the changes you make at src directory will reflect instantly in the app.
+- Any of the changes made for server requires the app to be restarted using: `npm run electron-start`
+
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. 
+Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+Feel free to join our slack chat group to get more help: [Slack](https://join.slack.com/t/powir/shared_invite/zt-ezy7sf5d-Tt1MmP_bcf_gdGLEJSEfzw)
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the GPU General Public License. See `LICENSE` for more information.
+
+<!-- CONTACT -->
+## Contact
+
+Hey there! I'm [Ujjwal](https://twitter.com/ugupta41) who goes around with the name Slapbot in open source communities, You'd often find me blabbering my completely biased opinions in /r/soccer or busy building new things.
+
+I'm most accessible via Twitter and tend to update about whatever I'm working there, so feel free to follow or send a dm there. :)
+
+
+## Acknowledgement
+Many thanks to these amazing frameworks/libraries/tools/arts without which none of this had been possible! <3
+
+#### Major Libraries
+- [ElectronJS](https://www.electronjs.org/)
+- [NodeJS](https://nodejs.org/en/)
+- [ReactJS](https://reactjs.org/)
+- [Tailwind](https://tailwindcss.com/)
+- [PaperCSS](https://www.getpapercss.com/)
+- [ChartJS](https://www.chartjs.org/)
+
+#### Minor Libraries
+- [Lodash](https://lodash.com/)
+- [JSSoup](https://github.com/chishui/JSSoup)
+- [JSSoup](https://github.com/chishui/JSSoup)
+
+#### Icons
+- [Icons8](https://icons8.com/)