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 28, 2016
1 parent 4b80ba7 commit 9f8e152
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@
![dependencies](https://img.shields.io/david/kittikjs/shape-image.svg)
![dev dependencies](https://img.shields.io/david/dev/kittikjs/shape-image.svg)

Image shape for Kittik slides
Image shape for Kittik slides.

__WARNING__: it requires experimental features of a terminal and I'm not guarantee it will work for you.

| Examples |
| -------- |
| ![kittik](https://cloud.githubusercontent.com/assets/3625244/16410206/122264e0-3d2a-11e6-86ea-71ce9a26955c.gif) |

## Getting Started

Expand All @@ -32,6 +38,12 @@ import Cursor from 'kittik-cursor';
Image.create(Cursor.create(), {image: 'filename.png'}).render();
```

There is not a lot options you can pass in, for more information take a look into API declaration.

## API

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

## License

The MIT License (MIT)
Expand Down

0 comments on commit 9f8e152

Please sign in to comment.