Skip to content

Commit

Permalink
docs(package): Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ghaiklor committed Jun 29, 2016
1 parent a49b39c commit aa04e0a
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@
![dependencies](https://img.shields.io/david/kittikjs/animation-print.svg)
![dev dependencies](https://img.shields.io/david/dev/kittikjs/animation-print.svg)

Print animation that simulates text typing
Print animation that simulates text typing in Kittik shapes.

| Examples |
| -------- |
| ![kittik](https://cloud.githubusercontent.com/assets/3625244/16447921/7ee264a4-3df7-11e6-8433-e66609d99ea4.gif) |

## Getting Started

Expand All @@ -36,6 +40,10 @@ const shape = Rectangle.create(cursor);
Print.create().animate(shape).then(shape => doSmthElseWithShape(shape));
```

## API

API declaration is [here](./API.md).

## License

The MIT License (MIT)
Expand Down

0 comments on commit aa04e0a

Please sign in to comment.