diff --git a/README.md b/README.md index c336cc8..87fa792 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ -# simple_timer +# Just a Timer -A new Flutter project. +It's just a timer. You can start it, pause it, stop it, and start it again. It can also do laps. + +## Features + +- A timer +- Record lap times +- Persistent storage of timer data +- Keyboard shortcuts for quick control + +## Screenshots + +![Timer](timer.png) ## Getting Started -This project is a starting point for a Flutter application. +1. Make sure you have Flutter installed on your machine +2. Clone this repository +3. Run `flutter pub get` to install dependencies +4. Launch the app with `flutter run` -A few resources to get you started if this is your first Flutter project: +## Platform Support -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +- Android +- Windows -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +## License + +This project is open source under the MIT License. diff --git a/timer.png b/timer.png new file mode 100644 index 0000000..587961b Binary files /dev/null and b/timer.png differ