Merge pull request #5 from ItsMrAkhil/readme.md

Readme.md and LICENSE files.

Author: ItsMrAkhil

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Akhil Pentamsetti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,61 @@
+# React Styled Slider
+**React Styled Slider** is a react and styled component slider. It is fully configurable.
+
+[![Build Status](https://travis-ci.org/ItsMrAkhil/react-styled-carousel.svg?branch=master)](https://travis-ci.org/ItsMrAkhil/react-styled-carousel)
+
+![Live Image](https://res.cloudinary.com/dzfragjmc/image/upload/v1519651815/ezgif-5-efffafcdbd_skf8yd.gif)
+
+#### Features
+  - Mostly configurable
+  - Styled-Components
+  - No external CSS required.
+  - Server Side Rendering supported
+
+> **Note:**  **Server Side Rendering** works well without the styled-components collectStyles function also. But for better user experience please use **collectStyles** function from **styled-components**
+
+#### Installation
+```sh
+$ npm install --save react-styled-carousel
+```
+
+#### Running example in local
+```sh
+$ git clone github.com/itsMrAkhil/react-styled-carousel
+$ npm start
+```
+It'll open localhost:9000 port, where you can see live demo.
+
+#### Example
+```js
+import React from 'react';
+import ReactDOM from 'react-dom'
+import Slider from 'react-styled-carousel';
+
+const ExampleSlider = () => (
+  <Slider>
+    <h1>1</h1>
+    <h1>2</h1>
+    <h1>3</h1>
+    <h1>4</h1>
+  </Slider>
+);
+
+ReactDOM.render(<ExampleSlider />, document.getElementById('root'));
+```
+
+#### Configurable Props
+Props | Type | Default Value | Description
+----- | ---- | ------------- | -----------
+`showArrows` | `Boolean` | `true` | If `true` then only Arrows of navigation will be shown
+`LeftArrow` | `React Node` | Default | Customized left arrow button
+`RightArrow` | `React Node` | Default | Customized right arrow button
+`showDots` | `Boolean` | `true` | Show navigation or pagination dots below the slider
+`Dot` | `React Node` | Default | Customized pagination button (`Active slide Dot` will get `active` as `Boolean` prop.)
+`children` | `React Node` | null | Cards are components which you want to show in the carousel
+`cardsToShow` | `Number` | Children length | How many cards to be shown for a single slide.
+`afterSlide` | `Function` | null | This function will be executed after every sliding is completed
+`beforeSlide` | `Function` | null | This function will be executed before starting every sliding
+
+License
+----
+MIT (**Free Software, Chill Yeah!**)