Skip to content

Commit

Permalink
Released 0.1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
oblador committed Oct 19, 2015
1 parent 84e7469 commit 673e9b0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# react-native-animatable
Standard set of easy to use animations for React Native

## Installation

`$ npm install react-native-animatable --save`

## Usage

To animate things you must use the `createAnimatableComponent` composer similar to the `Animated.createAnimatedComponent`. The common components `View`, `Text` and `Image` are precomposed and exposed under the `Animatable` namespace. If you have your own component that you wish to animate, simply wrap it with a `Animatable.View` or compose it with:
Expand All @@ -12,9 +16,8 @@ MyCustomComponent = Animatable.createAnimatableComponent(MyCustomComponent);

### Declarative Usage

```js
var Animatable = require('react-native-animatable');
var myFadingText = (<Animatable.Text animation="zoomInUp">Zoom me up, Scotty</Animatable.Text>);
```html
<Animatable.Text animation="zoomInUp">Zoom me up, Scotty</Animatable.Text>;
```

#### Properties
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "react-native-animatable",
"version": "0.1.0",
"description": "",
"description": "Standard set of easy to use animations for React Native",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
Expand Down

0 comments on commit 673e9b0

Please sign in to comment.