Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriel Peal committed Nov 15, 2017
1 parent 6a1abbb commit db50c60
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 43 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## V 4.13.0
- text expression support
- text update support with updateDocumentData (check wiki)
- tangentOnPath, normalOnPath and more expressions
- loaded_images event
- fixed global calls
- fixed ie9 error

## V 4.12.3
- valueAtTime fix

## V 4.12.2
- caching fix

## V 4.12.1
- velocityAtTime fix

## V 4.12.0
- pointOnLine support
- createPath support
- points, inTangents, outTangents support
- expressions fixes
- className for container via loading config
- 3d orientation fix
72 changes: 29 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,29 @@
# bodymovin
After Effects plugin for exporting animations to svg/canvas/html + js or natively on Android and iOS through [Lottie](https://medium.com/airbnb-engineering/introducing-lottie-4ff4a0afac0e)

## V 4.13.0
- text expression support
- text update support with updateDocumentData (check wiki)
- tangentOnPath, normalOnPath and more expressions
- loaded_images event
- fixed global calls
- fixed ie9 error

## V 4.12.3
- valueAtTime fix

## V 4.12.2
- caching fix

## V 4.12.1
- velocityAtTime fix

## V 4.12.0
- pointOnLine support
- createPath support
- points, inTangents, outTangents support
- expressions fixes
- className for container via loading config
- 3d orientation fix

# Lottie + Bodymovin
Lottie is the native engine that Airbnb's awesome team built. It uses Bodymovin as the animation exporter and is the ideal complement for getting animations to play natively everywhere.
Follow these links to get each player:
- [Android's player](https://github.com/airbnb/lottie-android)
- [iOS's player](https://github.com/airbnb/lottie-ios)
- [React Native's wrapper](https://github.com/airbnb/lottie-react-native)

## Lottie and AVD
Some animations can be exported for Android using the AVD format.
It can fit for some cases where you'll gain a performance improvement.
But Lottie brings much more features, a level of animation control and dynamic loading that couldn't be achieved with avd.
Here's a [link](http://airbnb.io/lottie/lottie-avd.html) with a full comparison of both technologies.
# Lottie for Web, [Android](https://github.com/airbnb/lottie-android), [iOS](https://github.com/airbnb/lottie-ios), and [React Native](https://github.com/airbnb/lottie-react-native)

Lottie is a mobile library for Web, and iOS that parses [Adobe After Effects](http://www.adobe.com/products/aftereffects.html) animations exported as json with [Bodymovin](https://github.com/airbnb/lottie-web) and renders them natively on mobile!

For the first time, designers can create **and ship** beautiful animations without an engineer painstakingly recreating it by hand. They say a picture is worth 1,000 words so here are 13,000:



# View documentation, FAQ, help, examples, and more at [airbnb.io/lottie](http://airbnb.io/lottie/)



![Example1](gifs/Example1.gif)


![Example2](gifs/Example2.gif)


![Example3](gifs/Example3.gif)


![Community](gifs/Community%202_3.gif)


![Example4](gifs/Example4.gif)


# Plugin installation

Expand Down Expand Up @@ -149,8 +135,8 @@ Check this wiki page for an explanation for each setting.
https://github.com/bodymovin/bodymovin/wiki/Composition-Settings

## Usage
Animation instances have these main methods:
### play
Animation instances have these main methods:
### play

***
### stop
Expand Down Expand Up @@ -192,7 +178,7 @@ Animation instances have these main methods:
***

### Aditional methods:
- updateTextDocumentData -- updates a text layer's data
- updateTextDocumentData -- updates a text layer's data
[More Info](https://github.com/bodymovin/bodymovin/wiki/TextLayer.updateDocumentData)
***

Expand Down
Binary file added gifs/Community 2_3.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gifs/Example1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gifs/Example2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gifs/Example3.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gifs/Example4.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit db50c60

Please sign in to comment.