Skip to content

Commit

Permalink
Updating docs with example
Browse files Browse the repository at this point in the history
  • Loading branch information
leandrowd committed Sep 7, 2016
1 parent a55c4a1 commit 6feaeb4
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ ReactDOM.render(<DemoCarousel />, document.querySelector('.demo-carousel'));
```

| Attributes | Type | Default | Description |
| ---------- | :--: | :-----: | ----------- |
| :--------- | :--: | :-----: | ----------- |
| showArrows | `boolean` | `true` | show prev and next arrows |
| showStatus | `boolean` | `true` | show index of the current item. i.e: (1/8) |
| showIndicators | `boolean` | `true` | show little dots at the bottom with links for changing the item |
Expand All @@ -55,7 +55,6 @@ ReactDOM.render(<DemoCarousel />, document.querySelector('.demo-carousel'));
| onClickThumb | `function` | - | Fired when a thumb it clicked |



#### Contributing
Please, feel free to contribute. You may file an issue or submit a pull request!

Expand All @@ -73,3 +72,7 @@ Please, feel free to contribute. You may file an issue or submit a pull request!

##### Pubishing to gh-pages
- `npm run publish-to-gh-pages`

### Examples
#### webpack + es6 setup
<https://github.com/leandrowd/demo-react-responsive-carousel-es6>

0 comments on commit 6feaeb4

Please sign in to comment.