diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..8254738 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,4 @@ +{ + "projectName": "Fuelish>", + "projectOwner": "Doofenshmirtz-Evil-Incorp" +} \ No newline at end of file diff --git a/README.md b/README.md index 96cbdbc..a3c3c36 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,28 @@ Fuelish is a simple web application that helps you to check the fuel prices of y - [Fuelish](#fuelish) - [Table of Contents](#table-of-contents) - [Features](#features) + - [Screenshots](#screenshots) - [Technologies Used](#technologies-used) - [Installation](#installation) - [Usage](#usage) - [Contributing](#contributing) - [Author](#author) + - [Contributors](#contributors) - [License](#license) ## Features -- Fuelish displays the latest fuel prices of your state -- Fuelish displays the petrol and diesel price and the daily changes so you can avoid overpaying for gas. +- Displays the latest fuel prices of your state +- Displays the petrol and diesel price and the daily changes so you can avoid overpaying for gas. +- Finds out the lowest price within 50-kms radius. +- Directs you to the nearest petrol pump. +- Live Location! (Don't need to explain) +## Screenshots +![Screenshot of the website](images/screenshots/1.jpg "a title") + +![Screenshot of the website](images/screenshots/2.jpg "a title") + +![Screenshot of the website](images/screenshots/3.jpg "a title") ## Technologies Used @@ -27,6 +38,7 @@ Fuelish is built with the following technologies: - CSS, because we don't want our app to look like it's from the 90s. - JavaScript, because we want to make our app interactive. - OpenMaps API, because we want to show you your location. +- Vercel for deployment. ## Installation @@ -57,6 +69,17 @@ We welcome contributions from the community, especially if you're willing to bri Fuelish was created by [Aryaman Srivastava](https://github.com/actuallyaryaman) and [Asvin Jain](https://github.com/asvin1), two fuel-saving ninjas who believe that the only thing better than a full tank of gas is a full tank of gas that didn't break the bank. If you have any questions or feedback, you can reach out to us at We promise to respond faster than a V8 engine revving up! +## Contributors + + + + + + + + + + ## License Fuelish is licensed under the GNU V3 License. See the [LICENSE](LICENSE) file for details. This license ensures that if you become a millionaire because of the money you saved using Fuelish, you'll still have to give us credit for it. diff --git a/images/screenshots/1.jpg b/images/screenshots/1.jpg new file mode 100644 index 0000000..dc6c25d Binary files /dev/null and b/images/screenshots/1.jpg differ diff --git a/images/screenshots/2.jpg b/images/screenshots/2.jpg new file mode 100644 index 0000000..61093ee Binary files /dev/null and b/images/screenshots/2.jpg differ diff --git a/images/screenshots/3.jpg b/images/screenshots/3.jpg new file mode 100644 index 0000000..08c5043 Binary files /dev/null and b/images/screenshots/3.jpg differ