feat: Updated README.md

README.md

@@ -1 +1,47 @@
-# carbon-footprint-calculator
+
+# Carbon-Footprint-Calculator
+
+This webapp was developed as part of [Tech Skills Showcase Competition](https://rods.sk.ca/events/tech-skills-showcase/) organized by Regina Open Door Society on 8th Nov. 2023
+
+
+
+The app calculate carbon footprint of an user's car based on car make, model and milege driven.
+
+
+
+
+
+## Installation
+
+```bash
+git clone [email protected]:vatsalshah0791/carbon-footprint-calculator.git && cd carbon-footprint-calculator
+cp .env.sample .env
+npm install
+npm run serve 
+```
+
+## Environment Variables
+
+To run this project, you will need to add the following environment variables to your .env file
+
+`TOKEN`
+
+`APIURL`
+
+Create an account at
+[carboninterface](https://www.carboninterface.com)
+   to get your `TOKEN` and `APIURL` 
+
+
+## Authors
+
+[Vatsal Shah](https://www.github.com/vatsals0791)
+
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+
+## Front-end Module
+ [Regina-Tech-Talent-C02](https://github.com/smitesht/regina-tech-talent-co2)