adds license and proper readme

README.md

@@ -1,16 +1,74 @@
-# supplements
+# Supplements Tracker
 
-A new Flutter project.
+A Flutter application designed to help you track your daily supplement intake, manage dosages, and set reminders. This app aims to provide a simple and intuitive way to stay on top of your supplement regimen.
+
+## Features
+
+- **Supplement Management**: Easily add, edit, and delete supplements, including details like name, dosage, and frequency.
+- **Intake Tracking**: Log your daily supplement intake, marking when you've taken your doses.
+- **Reminders**: Set up local notifications to remind you when it's time to take your supplements.
+- **Customizable Theme**: Switch between light and dark themes to suit your preference.
+- **Local Data Storage**: All your supplement data is stored locally on your device.
+
+## Technologies Used
+
+- **Flutter**: The UI toolkit used for building natively compiled applications for mobile, web, and desktop from a single codebase.
+- **Provider**: A robust state management solution for Flutter applications.
+- **sqflite**: For efficient local database persistence using SQLite.
+- **shared_preferences**: To persist user settings and preferences locally.
+- **flutter_local_notifications**: For scheduling and displaying local notifications to remind you about dosages.
+- **timezone**: Ensures accurate time zone handling for notification scheduling.
+- **intl**: For internationalization and flexible date/time formatting.
 
 ## Getting Started
 
-This project is a starting point for a Flutter application.
+Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
 
-A few resources to get you started if this is your first Flutter project:
+### Prerequisites
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+Before you begin, ensure you have the following installed:
 
-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.
+- **Flutter SDK**: Refer to the [official Flutter installation guide](https://flutter.dev/docs/get-started/install) for detailed instructions.
+- An Integrated Development Environment (IDE) such as [VS Code](https://code.visualstudio.com/) with the Flutter extension, or [Android Studio](https://developer.android.com/studio).
+
+### Installation
+
+1.  **Clone the repository**:
+
+    ```bash
+    git clone https://github.com/vleeuwenmenno/supplements.git
+    cd supplements
+    ```
+
+2.  **Get dependencies**:
+    Navigate to the project directory and run:
+    ```bash
+    flutter pub get
+    ```
+
+### Running the Application
+
+To run the application on a connected device or emulator:
+
+```bash
+flutter run
+```
+
+To build a release version for a specific platform:
+
+- **Android APK**:
+  ```bash
+  flutter build apk --release
+  ```
+- **iOS (requires macOS and Xcode)**:
+  ```bash
+  flutter build ios --release
+  ```
+
+## Contributing
+
+Contributions are welcome! If you have suggestions for improvements or new features, please feel free to open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.