Update README.md

README.md

@@ -1,20 +1,38 @@
-# andronix-website-base
+<p align="center">
+ <img width="500" height="250" src="https://i.ibb.co/85hpwFx/readme-logo.png" alt="andronix-internal-api">
+</p>
 
-## Build Setup
+<p align="center">
+<a href=""><img src="https://github.com/imprakharshukla/andronix-website-base/workflows/Chrome%20E2E%20CI/badge.svg?branch=dev"></a>
+<a href=""><img src="https://github.com/imprakharshukla/andronix-website-base/workflows/Production%20Deploy/badge.svg?branch=master"></a>
+<a href=""><img src="https://github.com/imprakharshukla/andronix-website-base/workflows/Dev%20Deploy/badge.svg?branch=dev&event=push"></a>
+</p>
 
-```bash
-# install dependencies
-$ npm install
+## What is this? ⚡
+This is the repository of the official website for [Andronix App](https://git.andronix.app). This combines billing for the digital products that Andronix offers and Andronix Commands.
 
-# serve with hot reload at localhost:3000
-$ npm run dev
+> Andronix Commands will be added soon to this repo. It currently resides on [here](https://web.andronix.app) and is build with just VueJS and Tailwind.
 
-# build for production and launch server
-$ npm run build
-$ npm run start
+## What is the Tech-Stack? 📐
 
-# generate static project
-$ npm run generate
+This website/web-app is built using [NuxtJS](https://nuxtjs.org)  and [Tailwind](https://tailwindcss.com).  Deployed on [Netlify](https://netlify.com) and uses [GitHub Actions](https://github.com/features/actions) for the app pipeline.
+
+### - Testing 🤖
+We use [Cypress](https://cypress.io) for our E2E automated tests. Our unit and integration tests are done through [Mocha](https://mochajs.org) and [Chai](https://www.chaijs.com).
+
+## Developer Notes
+
+### How to run it locally? 🏠
+Clone the project and assuming that you have NodeJS installed on your machine already, run -
+``` bash
+# yarn
+yarn run dev # for the development server. 
+yarn run generate # for the production build. 
+
+# npm
+npm run dev # for the development server. 
+npm run generate # for the production build. 
 ```
 
-For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
+### How do I contribute? 🏗
+If you want to improve something or maybe add something new, you can just send a pull request and if that's something that we would like to add/change, we'll be more than happy to merge it.