flutter_timeline/README.md
2023-10-09 07:48:03 +02:00

39 lines
1.5 KiB
Markdown

# Flutter Timeline
![Flutter Timeline GIF](example.gif)
## Setup
To use this package, add flutter_timeline as a dependency in your pubspec.yaml file:
```
flutter_timeline
git:
url: https://github.com/Iconica-Development/flutter_timeline.git
path: packages/flutter_timeline
```
If you are going to use Firebase as the back-end of the Timeline, you should also add the following package as a dependency to your pubspec.yaml file:
```
flutter_timeline_firebase:
git:
url: https://github.com/Iconica-Development/flutter_timeline.git
path: packages/flutter_timeline_firebase
```
## How to use
To use the module within your Flutter-application you should add the following code to the build-method of a chosen widget.
## Issues
Please file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Iconica-Development/flutter_timeline/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).
## Want to contribute
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_timeline/pulls).
## Author
This `flutter_timeline` for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at <support@iconica.nl>