diff --git a/README.md b/README.md index f71af5f..c2b4f50 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -# Carousel +# React Carousel - +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( + + + + + + , + document.getElementById('root'), +); +``` diff --git a/package.json b/package.json index 662bdde..b275b30 100644 --- a/package.json +++ b/package.json @@ -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": [