From aaa6d03022f1c1e5cf45df58650e9e95505e05c0 Mon Sep 17 00:00:00 2001 From: Collin Jackson Date: Fri, 11 Oct 2019 08:34:00 -0700 Subject: [PATCH] [e2e] update README --- packages/e2e/CHANGELOG.md | 4 ++++ packages/e2e/README.md | 9 +++++---- packages/e2e/pubspec.yaml | 2 +- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/packages/e2e/CHANGELOG.md b/packages/e2e/CHANGELOG.md index 44ec042e8066..ee813dc1c88f 100644 --- a/packages/e2e/CHANGELOG.md +++ b/packages/e2e/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.2.0+1 + +* Updated README. + ## 0.2.0 * Renamed package from instrumentation_adapter to e2e. diff --git a/packages/e2e/README.md b/packages/e2e/README.md index 9b1dab18a2d5..04a701ae0784 100644 --- a/packages/e2e/README.md +++ b/packages/e2e/README.md @@ -1,7 +1,8 @@ # e2e -Adapts flutter_test results as Android instrumentation tests, making them usable -for Firebase Test Lab and other Android CI providers. +This package enables self-driving testing of Flutter code on devices and emulators. +It can adapt the test results in a format that is compatible with `flutter drive` +and native Android instrumentation testing. iOS support is not available yet, but is planned in the future. @@ -11,14 +12,14 @@ Add a dependency on the `e2e` package in the `dev_dependencies` section of pubspec.yaml. For plugins, do this in the pubspec.yaml of the example app. -Invoke `InstrumentationAdapterFlutterBinding.ensureInitialized()` at the start +Invoke `E2EWidgetsFlutterBinding.ensureInitialized()` at the start of a test file, e.g. ```dart import 'package:e2e/e2e.dart'; void main() { - InstrumentationAdapterFlutterBinding.ensureInitialized(); + E2EWidgetsFlutterBinding.ensureInitialized(); testWidgets("failing test example", (WidgetTester tester) async { expect(2 + 2, equals(5)); }); diff --git a/packages/e2e/pubspec.yaml b/packages/e2e/pubspec.yaml index 6e8bab883d91..2515a51f07fd 100644 --- a/packages/e2e/pubspec.yaml +++ b/packages/e2e/pubspec.yaml @@ -1,6 +1,6 @@ name: e2e description: Runs tests that use the flutter_test API as integration tests. -version: 0.2.0 +version: 0.2.0+1 author: Flutter Team homepage: https://github.com/flutter/plugins/tree/master/packages/e2e