Complete ReadME

Author: faisalAkhtar

ReadME.md

@@ -1,2 +1,76 @@
-# Github Card
-![SS](https://ancient-tundra-94967.herokuapp.com/card?user=goyalshubhangi)
+<h1 align="center">Github Card</h1>
+
+<p align="center">
+ A beautiful, dynamically generated <i>unofficial</i> github card for you
+</p>
+
+<p align="center">
+  <img alt="Issues" src="https://img.shields.io/github/issues/faisalAkhtar/github-card?color=0088ff" />
+  &nbsp;
+  <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/faisalAkhtar/github-card?color=0088ff" />
+  &nbsp;
+  <a href="LICENSE"><img alt="license MIT" src="https://img.shields.io/static/v1?label=LICENSE&message=MIT&color=informational" /></a>
+</p>
+
+<p align="center">
+  <a href="#usage">Usage</a>
+  ·
+  <a href="https://github.com/faisalAkhtar/github-card/issues/new/choose">Report Bug</a>
+  ·
+  <a href="https://github.com/faisalAkhtar/github-card/issues/new/choose">Request Feature</a>
+</p>
+
+<p align="center">
+  <img src="https://ancient-tundra-94967.herokuapp.com/card?user=faisalAkhtar" width="700">
+  <br>
+  GitHub Card
+</p>
+
+
+## Usage
+Copy-paste this code where you want to use the image (e.g., into your readme) and change the links
+
+Endpoint: `/api?username=<github-username>`
+
+Insert a valid github username in `<github-username>` and you'll receive a github-card in SVG
+
+```md
+![Faisal's github card](https://ancient-tundra-94967.herokuapp.com/api?username=faisalakhtar)]
+```
+OR
+```md
+<img alt="Faisal's github card" src="https://ancient-tundra-94967.herokuapp.com/api?username=faisalakhtar">
+```
+
+
+## Contributing
+### Step 1
+- Option 1
+  - :fork_and_knife: Fork this repository
+- Option 2
+  -  :dancers: Clone this repo to your local machine using ```git clone https://github.com/faisalakhtar/github-card.git```
+
+### Step 2
+- **HACK AWAY** :hammer: :hammer: :hammer:
+
+### Step 3
+- :repeat: Create a pull request using https://github.com/faisalakhtar/github-card/compare/
+
+
+## Built with
+
+<p align="center">
+<img width="150" src="https://github.com/faisalAkhtar/dear-diary/blob/master/screenshots/ejs.png?raw=true" alt="Embedded JavaScript templating" title="Embedded JavaScript templating">&emsp;<img width="90" src="https://www.w3.org/Icons/SVG/svg-logo-v.png" alt="W3C SVG Logo" title="SVG">&emsp;<img width="150" src="https://expressjs.com/images/express-facebook-share.png" alt="Express JS" title="Express JS">&emsp;<img width="125" src="https://upload.wikimedia.org/wikipedia/commons/thumb/d/d9/Node.js_logo.svg/1200px-Node.js_logo.svg.png" alt="NodeJS" title="NodeJS">&emsp;<img width="80" src="https://user-images.githubusercontent.com/13700/35731649-652807e8-080e-11e8-88fd-1b2f6d553b2d.png" alt="Nodemon" title="Nodemon">&emsp;<img width="100" src="https://upload.wikimedia.org/wikipedia/commons/thumb/6/6c/Cloud-API-Logo.svg/1200px-Cloud-API-Logo.svg.png" alt="REST APIs" title="REST APIs">&emsp;<img width="175" src="https://www.w3.org/html/logo/badge/html5-badge-h-css3.png" alt="HTML5 Powered with CSS3 / Styling" title="HTML5 Powered with CSS3 / Styling">&emsp;<img width="90" src="https://upload.wikimedia.org/wikipedia/commons/6/6a/JavaScript-logo.png" alt="JavaScript" title="JavaScript">
+</p>
+
+## Licensing
+
+[![license MIT](https://img.shields.io/static/v1?label=LICENSE&message=MIT&color=informational)](LICENSE)
+
+All SVGs, scripts, stylesheets and markups are distributed under the [MIT](LICENSE) license.
+
+## Acknowledgements
+
+- Some icons in this READme were borrowed from [here](https://commons.wikimedia.org/wiki/Main_Page)
+
+- CORS icon was taken from [mozilla](https://mozilla.org/) and is licensed under [Creative Commons Attribution Share-Alike License v3.0](https://creativecommons.org/licenses/by-sa/3.0/)