flutter_introduction/README.md

39 lines
1.7 KiB
Markdown
Raw Normal View History

# Flutter Introduction
2022-10-07 15:31:07 +02:00
2023-11-29 13:23:58 +01:00
![Introduction GIF](flutter_introduction_widget.gif)
2023-11-27 09:26:18 +01:00
Monorepo for the Flutter introduction package. Including the following packages:
- Flutter Introduction
2023-11-29 13:23:58 +01:00
Main package for Flutter Introduction including an example.
2023-11-27 09:26:18 +01:00
- Flutter Introduction Firebase
Package to provide content from firebase.
- Flutter Introduction Interface
2023-11-29 13:23:58 +01:00
Interface regarding data for the Introduction widget, like whether to show the introduction or not.
2023-11-27 09:26:18 +01:00
- Flutter Introduction Service
2023-11-29 11:13:17 +01:00
Service to handle actions done in the Introduction widget.
2023-11-27 09:26:18 +01:00
- Flutter Introduction Shared Preferences
2023-11-29 11:13:17 +01:00
Implementation of the interface with the use of shared preferences.
2023-11-27 09:26:18 +01:00
- Flutter Introduction Widget
2023-11-29 11:13:17 +01:00
The actual widget showing the Introduction widget.
2022-10-07 15:31:07 +02:00
## How to use
2023-11-29 11:13:17 +01:00
The simple way to use this package is by using the flutter_introduction package. An example is included if needed.
2022-10-07 15:31:07 +02:00
2023-11-29 11:13:17 +01:00
If needed a custom implementation can be made on the interface if the shared preferences doesn't suffice.
2022-10-07 15:31:07 +02:00
## Issues
2022-10-07 15:31:07 +02:00
Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Iconica-Development/flutter_introduction/pulls) page. Commercial support is available if you need help with integration with your app or services. You can contact us at [support@iconica.nl](mailto:support@iconica.nl).
2022-10-07 15:31:07 +02:00
## Want to contribute
2022-10-07 15:31:07 +02:00
If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Iconica-Development/flutter_introduction/pulls).
2022-10-07 15:31:07 +02:00
## Author
2022-10-07 15:31:07 +02:00
This `flutter_introduction` for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at <support@iconica.nl>