diff --git a/brick/__brick__/{{project_name.snakeCase()}}/README.md b/brick/__brick__/{{project_name.snakeCase()}}/README.md index 14d23f4..16773d5 100644 --- a/brick/__brick__/{{project_name.snakeCase()}}/README.md +++ b/brick/__brick__/{{project_name.snakeCase()}}/README.md @@ -13,6 +13,21 @@ A Very Good Flutter Federated Plugin created by the [Very Good Ventures Team][ve Generated by the [Very Good CLI][very_good_cli_link] ๐Ÿค– + +### Integration tests ๐Ÿงช + +Very Good Flutter Plugin uses [fluttium][fluttium_link] for integration tests. Those tests are located +in the front facing package `{{project_name.snakeCase()}}` example. + +**โ— In order to run the integration tests, you need to have the `fluttium_cli` installed. [See how][fluttium_install].** + +To run the integration tests, run the following command from the root of the project: + +```sh +cd {{project_name.snakeCase()}}/example +fluttium test flows/test_platform_name.yaml +``` + [coverage_badge]: {{project_name.snakeCase()}}/coverage_badge.svg [license_badge]: https://img.shields.io/badge/license-MIT-blue.svg [license_link]: https://opensource.org/licenses/MIT @@ -24,3 +39,5 @@ Generated by the [Very Good CLI][very_good_cli_link] ๐Ÿค– [very_good_ventures_link]: https://verygood.ventures/?utm_source=github&utm_medium=banner&utm_campaign=core [very_good_ventures_link_dark]: https://verygood.ventures/?utm_source=github&utm_medium=banner&utm_campaign=core#gh-dark-mode-only [very_good_ventures_link_light]: https://verygood.ventures/?utm_source=github&utm_medium=banner&utm_campaign=core#gh-light-mode-only +[fluttium_link]: https://fluttium.dev/ +[fluttium_install]: https://fluttium.dev/docs/getting-started/installing-cli \ No newline at end of file