Skip to content

Commit

Permalink
update documentation (#36)
Browse files Browse the repository at this point in the history
* add project screenshots

* add .all-contributor, credit for all!

* update readme; add contributor section

* fix screenshot size

* update readme

* update readme
  • Loading branch information
actuallyaryaman authored Oct 11, 2023
1 parent cbba5bd commit 3bfd09b
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"projectName": "Fuelish>",
"projectOwner": "Doofenshmirtz-Evil-Incorp"
}
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## 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.
Binary file added images/screenshots/1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshots/2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshots/3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3bfd09b

Please sign in to comment.