diff --git a/README.md b/README.md index 3592ff0..889ed8c 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,25 @@ This app is designed to help you keep track of your car's statistics such as fuel efficiency and cost. By inputting data for each fill up, the app will calculate your car's liters per 100 km, km per liter, and cost per km. The app also provides visual graphs to help you visualize your car's statistics over time. -### Features +## Features + Input and store data for each fill-up including kilometers driven, liters of fuel, and cost. + Automatically calculate and display fuel efficiency statistics such as liters per 100 km, km per liter, and cost per km. + View visual graphs to track your car's statistics over time. -### Getting Started +## Getting Started -#### Prerequisites +### Prerequisites To use this app, you will need an Android device running Android 8.0 or later. -#### Installation +### Installation + Download the app from the latest [Release](https://github.com/GeorgeMC2610/BenzinApp/releases). + Install the app on your Android device. + Open the app and start inputting data for each fill up. -### Usage +## Usage + Open the app. + Create an account. Enter your car info (Manufcaturer, Model, Year). @@ -29,6 +29,6 @@ To use this app, you will need an Android device running Android 8.0 or later. + The app will automatically calculate liters per 100 km, km per liter, and cost per km. + View visual graphs to track your car's statistics over time. -### Contributing +## Contributing Contributions are welcome from anyone who would like to help improve this app (especially the front-end). If you would like to contribute, please fork the repository and submit a pull request. The source code is available to anyone and can be edited freely when forked.