Skip to content
This repository was archived by the owner on Apr 14, 2020. It is now read-only.

Commit fada451

Browse files
committed
chore: updates readme
1 parent a8b6541 commit fada451

File tree

2 files changed

+30
-17
lines changed

2 files changed

+30
-17
lines changed

README.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# yubaba
22

3-
is an element to element animation orchestrator for React.js ✨
3+
is an element animation orchestrator for React.js ✨
44

55
[![npm](https://img.shields.io/npm/v/yubaba.svg)](https://www.npmjs.com/package/yubaba)
66
[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/yubaba.svg)](https://bundlephobia.com/result?p=yubaba)
@@ -9,28 +9,30 @@ is an element to element animation orchestrator for React.js ✨
99

1010
[![Example animation using yubaba](https://github.com/madou/yubaba/raw/master/test/images/intro.gif)](https://yubaba.netlify.com/?selectedKind=yubaba-examples%2FParentChild%2FEmailThreads&selectedStory=Default&full=0&addons=1&stories=1&panelRight=1&addonPanel=storybook%2Fnotes%2Fpanel)
1111

12+
## Why yubaba?
13+
14+
`yubaba` is as much of a _platform_ as it is an **orchestrator**.
15+
It comes with prebuilt animations you can drop in and start using immediately,
16+
such as [ConcealMove](https://yubaba.netlify.com/?selectedKind=yubaba%2FConcealMove&selectedStory=TargetHeight&full=0&addons=1&stories=1&panelRight=1&addonPanel=storybook%2Fnotes%2Fpanel) and [RevealMove](https://yubaba.netlify.com/?selectedKind=yubaba%2FRevealMove&selectedStory=TargetHeight&full=0&addons=1&stories=1&panelRight=1&addonPanel=storybook%2Fnotes%2Fpanel) which together can [create an awesome user experience](https://yubaba.netlify.com/?selectedKind=yubaba-examples%2FParentChild%2FEmailThreads&selectedStory=Default&full=0&addons=1&stories=1&panelRight=1&addonPanel=storybook%2Fnotes%2Fpanel)!
17+
18+
But even better you can create _custom_ animations!
19+
Using the same [internals](#collector) the [prebuilt animations use](https://github.com/madou/yubaba/tree/master/packages/yubaba/src/animations),
20+
it comes with a first class customization experience for you to do,
21+
well,
22+
anything!
23+
1224
## Installation
1325

1426
```bash
15-
npm install yubaba --save
27+
npm install yubaba emotion --save
1628
```
1729

1830
or
1931

2032
```bash
21-
yarn add yubaba
33+
yarn add yubaba emotion
2234
```
2335

24-
## Motivation
25-
26-
Complex page transitions are becoming more common on the web but we're still at a point where we need to write a lot of boilerplate to make it happen,
27-
worse yet disjointed parts of our apps needing to know about each other to make it all work.
28-
29-
Yubaba tries to solve this by allowing disjointed parts of your app define what animations they want to happen when a matching partner is found,
30-
without explicit knowledge of each other.
31-
32-
See usage and examples for a deeper look at this.
33-
3436
## Examples
3537

3638
- [All examples](https://yubaba.netlify.com)
@@ -161,7 +163,7 @@ import Baba from 'yubaba';
161163

162164
Used to explicitly mark the focal element,
163165
only a handful of animations require this component to be used,
164-
for example [Reveal](#reveal)`.
166+
for example [Reveal](#reveal).
165167

166168
```jsx
167169
import Baba, { FocalTarget } from 'yubaba';

packages/yubaba/package.json

+14-3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@
77
"main": "dist/cjs/packages/yubaba/src/index.js",
88
"module": "dist/es6/packages/yubaba/src/index.js",
99
"sideEffects": false,
10+
"description": "is an element animation orchestrator for React.js ✨",
11+
"keywords": [
12+
"react",
13+
"flip",
14+
"animation",
15+
"transition",
16+
"magic-move",
17+
"reactjs",
18+
"element-to-element",
19+
"material-transition"
20+
],
1021
"scripts": {
1122
"build": "rm -rf dist && tsc -p ./tsconfig.cjs.json && tsc -p ./tsconfig.es6.json && cp ../../README.md README.md",
1223
"size": "size-limit"
@@ -18,9 +29,9 @@
1829
}
1930
],
2031
"peerDependencies": {
21-
"emotion": "^9.2.9",
22-
"react": "^16.4.x",
23-
"react-dom": "^16.4.x"
32+
"emotion": "~9",
33+
"react": "~16.4",
34+
"react-dom": "~16.4"
2435
},
2536
"devDependencies": {
2637
"@storybook/addon-actions": "^3.4.10",

0 commit comments

Comments
 (0)