Refresh README (#97)
* Refresh README
diff --git a/packages/animations/CHANGELOG.md b/packages/animations/CHANGELOG.md
index a11fca7..0e095c2 100644
--- a/packages/animations/CHANGELOG.md
+++ b/packages/animations/CHANGELOG.md
@@ -1,3 +1,8 @@
+## [1.0.0+3] - February 18, 20200
+
+* Update README.md to better describe Material motion
+
+
## [1.0.0+2] - February 18, 20200
* Fixes to pubspec.yaml
diff --git a/packages/animations/README.md b/packages/animations/README.md
index da2a94d..3a6f046 100644
--- a/packages/animations/README.md
+++ b/packages/animations/README.md
@@ -1,4 +1,4 @@
-# Fancy pre-built Animations for Flutter
+# High quality pre-built Animations for Flutter
This package contains pre-canned animations for commonly-desired effects. The animations can be customized with your content and dropped into your application to delight your users.
@@ -9,42 +9,63 @@
flutter run --release
```
-## Available Animations
+## Material motion for Flutter
-Currently, the following animated effects are available in this library:
+Material motion is a set of transition patterns that help users understand and navigate an app. Currently,
+the following transition patterns are available in this library:
-### Material's Open Container Transitions
+1. [Container transform](#container-transform)
+2. [Shared axis](#shared-axis)
+3. [Fade through](#fade-through)
+4. [Fade](#fade)
-Tapping on a container (e.g. a card or a button) will expand the container to reveal more information.
+### Container transform
-| Card with Fade Transition | Card with Fade Through Transition |
-:------------------------------------:|:------------------------------------:
-||
-| **Floating Action Button with Fade Transition** | **Floating Action Button with Fade Through Transition** |
-||
-### Material's Shared Axis Transitions
+The **container transform** pattern is designed for transitions between UI elements that include a container. This pattern creates a visible connection between two UI elements.
-A transition animation between UI elements that have a spatial or navigational
-relationship.
+
+_Examples of the container transform:_
-| Horizontal (x-axis) | Vertical (y-axis) | Scaled (z-axis) |
-:-------------------------:|:-----------------------:|:--------------------:|
-|||
+1. _A card into a details page_
+2. _A list item into a details page_
+3. _A FAB into a details page_
+4. _A search bar into expanded search_
-### Material's Fade Through Transition
+### Shared axis
-A transition animation between UI elements that have do not have a strong
-relationship to one another.
+The **shared axis** pattern is used for transitions between UI elements that
+have a spatial or navigational relationship. This pattern uses a shared
+transformation on the x, y, or z axis to reinforce the relationship between
+elements.
-| Fade Through Page Transition |
-:-----------------------------:|
-||
+
+_Examples of the shared axis pattern:_
-### Material's Fade Transition
+1. _An onboarding flow transitions along the x-axis_
+2. _A stepper transitions along the y-axis_
+3. _A parent-child navigation transitions along the z-axis_
-The fade pattern is used for UI elements that enter or exit from within
-the screen bounds.
+### Fade through
-| Modal Fade Transition | Floating Action Button Fade Transition |
-:----------------------------------:|:----------------------------------------:
-||
+The **fade through** pattern is used for transitions between UI elements that do
+not have a strong relationship to each other.
+
+
+_Examples of the fade through pattern:_
+
+1. _Tapping destinations in a bottom navigation bar_
+2. _Tapping a refresh icon_
+3. _Tapping an account switcher_
+
+### Fade
+
+The **fade** pattern is used for UI elements that enter or exit within the
+bounds of the screen, such as a dialog that fades in the center of the screen.
+
+
+_Examples of the fade pattern:_
+
+1. _A dialog_
+2. _A menu_
+3. _A snackbar_
+4. _A FAB_
diff --git a/packages/animations/example/demo_gifs/container_transform_lineup.gif b/packages/animations/example/demo_gifs/container_transform_lineup.gif
new file mode 100644
index 0000000..c17dab1
--- /dev/null
+++ b/packages/animations/example/demo_gifs/container_transform_lineup.gif
Binary files differ
diff --git a/packages/animations/example/demo_gifs/fade_floating_action_button_demo.gif b/packages/animations/example/demo_gifs/fade_floating_action_button_demo.gif
deleted file mode 100644
index f1873b2..0000000
--- a/packages/animations/example/demo_gifs/fade_floating_action_button_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/fade_lineup.gif b/packages/animations/example/demo_gifs/fade_lineup.gif
new file mode 100644
index 0000000..76dbd18
--- /dev/null
+++ b/packages/animations/example/demo_gifs/fade_lineup.gif
Binary files differ
diff --git a/packages/animations/example/demo_gifs/fade_modal_demo.gif b/packages/animations/example/demo_gifs/fade_modal_demo.gif
deleted file mode 100644
index 91b4071..0000000
--- a/packages/animations/example/demo_gifs/fade_modal_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/fade_through_demo.gif b/packages/animations/example/demo_gifs/fade_through_demo.gif
deleted file mode 100644
index ca130b8..0000000
--- a/packages/animations/example/demo_gifs/fade_through_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/fade_through_lineup.gif b/packages/animations/example/demo_gifs/fade_through_lineup.gif
new file mode 100644
index 0000000..4c5095b
--- /dev/null
+++ b/packages/animations/example/demo_gifs/fade_through_lineup.gif
Binary files differ
diff --git a/packages/animations/example/demo_gifs/open_container_fade_card_demo.gif b/packages/animations/example/demo_gifs/open_container_fade_card_demo.gif
deleted file mode 100644
index 617d6d7..0000000
--- a/packages/animations/example/demo_gifs/open_container_fade_card_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/open_container_fade_floating_action_button_demo.gif b/packages/animations/example/demo_gifs/open_container_fade_floating_action_button_demo.gif
deleted file mode 100644
index 6e89dbd..0000000
--- a/packages/animations/example/demo_gifs/open_container_fade_floating_action_button_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/open_container_fade_through_card_demo.gif b/packages/animations/example/demo_gifs/open_container_fade_through_card_demo.gif
deleted file mode 100644
index dcc006d..0000000
--- a/packages/animations/example/demo_gifs/open_container_fade_through_card_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/open_container_fade_through_floating_action_button_demo.gif b/packages/animations/example/demo_gifs/open_container_fade_through_floating_action_button_demo.gif
deleted file mode 100644
index 91b84f0..0000000
--- a/packages/animations/example/demo_gifs/open_container_fade_through_floating_action_button_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/shared_axis_horizontal_demo.gif b/packages/animations/example/demo_gifs/shared_axis_horizontal_demo.gif
deleted file mode 100644
index 63f67c8..0000000
--- a/packages/animations/example/demo_gifs/shared_axis_horizontal_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/shared_axis_lineup.gif b/packages/animations/example/demo_gifs/shared_axis_lineup.gif
new file mode 100644
index 0000000..2d92418
--- /dev/null
+++ b/packages/animations/example/demo_gifs/shared_axis_lineup.gif
Binary files differ
diff --git a/packages/animations/example/demo_gifs/shared_axis_scaled_demo.gif b/packages/animations/example/demo_gifs/shared_axis_scaled_demo.gif
deleted file mode 100644
index d1f613e..0000000
--- a/packages/animations/example/demo_gifs/shared_axis_scaled_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/example/demo_gifs/shared_axis_vertical_demo.gif b/packages/animations/example/demo_gifs/shared_axis_vertical_demo.gif
deleted file mode 100644
index 5b7e168..0000000
--- a/packages/animations/example/demo_gifs/shared_axis_vertical_demo.gif
+++ /dev/null
Binary files differ
diff --git a/packages/animations/pubspec.yaml b/packages/animations/pubspec.yaml
index 3acac8f..df317e6 100644
--- a/packages/animations/pubspec.yaml
+++ b/packages/animations/pubspec.yaml
@@ -1,6 +1,6 @@
name: animations
description: Fancy pre-built animations that can easily be integrated into any Flutter application.
-version: 1.0.0+2
+version: 1.0.0+3
homepage: https://github.com/flutter/packages/tree/master/packages/animations
environment:
