update readme.md

master
Hasan Genc 5 years ago
parent e5e13134c7
commit 8b00ef670a
  1. 29
      README.md
  2. 4
      package.json

@ -1,3 +1,28 @@
# Carousel
# React Carousel
<img src="docs/carousel.png" height="300px">
Please visit to [docs website](https://trendyol.github.io/react-carousel/docs/installation) to more details.
# Installation
```
npm i react react-dom @trendyol/react-carousel --save
```
# Usage
```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import { Carousel } from '@trendyol/react-carousel';
import { Item } from './yourItem';
ReactDOM.render(
<Carousel>
<Item />
<Item />
<Item />
<Item />
</Carousel>,
document.getElementById('root'),
);
```

@ -25,8 +25,8 @@
},
"husky": {
"hooks": {
"pre-commit": "npm lint:staged",
"pre-push": "npm test"
"pre-commit": "npm run lint:staged",
"pre-push": "npm run test"
}
},
"keywords": [

Loading…
Cancel
Save