add readme file

Author: isuruAb

.gitignore

@@ -2,8 +2,82 @@
 /demo/dist
 /es
 /lib
-/node_modules
 /umd
 npm-debug.log*
 
-.DS_Store
+# Logs
+ logs
+ *.log
+ npm-debug.log*
+ yarn-debug.log*
+ yarn-error.log*
+ 
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# VS Code
+.vscode/*
+
+# Windows
+Thumbs.db
+Desktop.ini
+
+# Mac
+.DS_Store
+**/.DS_Store
+
+# JetBrains
+.idea
+.project
+.settings
+.idea/*
+*.iml

README.md

@@ -1,16 +1,80 @@
-# pagination-react
+# @99xt/pagination-react
 
-[![Travis][build-badge]][build]
 [![npm package][npm-badge]][npm]
 [![Coveralls][coveralls-badge]][coveralls]
+[![license](https://img.shields.io/github/license/99xt/react-pagination.svg)](https://github.com/99xt/react-pagination/blob/master/LICENSE)
+[![Build Status](https://travis-ci.org/99xt/react-pagination.svg?branch=master)](https://travis-ci.org/99xt/react-pagination)
 
-Describe pagination-react here.
-
-[build-badge]: https://img.shields.io/travis/user/repo/master.png?style=flat-square
-[build]: https://travis-ci.org/user/repo
 
 [npm-badge]: https://img.shields.io/npm/v/npm-package.png?style=flat-square
 [npm]: https://www.npmjs.org/package/npm-package
 
 [coveralls-badge]: https://img.shields.io/coveralls/user/repo/master.png?style=flat-square
 [coveralls]: https://coveralls.io/github/user/repo
+
+Simple pagination component for React JS apps.
+
+
+## Installation
+
+To install this library, run:
+
+```bash
+npm install @99xt/pagination-react --save
+```
+
+## Usage
+
+example.react.js
+
+```html
+<pagination
+  total="totalRecordCount"
+  limit="recordsPerPage"
+>
+</pagination>
+```
+
+## Contributing Guide
+
+### Setting up the development environment
+
+Clone the repository to your workstation
+
+```bash
+git clone git@github.com:99xt/react-pagination.git
+```
+
+Navigate to the project directory 
+
+```bash
+cd react-pagination
+```
+
+Install and build the library
+
+```bash
+npm install
+```
+
+### Run Demo app
+
+```
+npm install
+npm start
+```
+
+check localhost:3000 to see the preview of the demo
+
+### Publish to NPM
+
+Update the version in `package.json`;
+
+```
+npm run build
+npm publish
+```
+
+## License
+
+MIT

tests/index-test.js

@@ -15,9 +15,9 @@ describe('Component', () => {
     unmountComponentAtNode(node)
   })
 
-  it('displays a welcome message', () => {
+  it('sample test case', () => {
     render(<Component/>, node, () => {
-      expect(node.innerHTML).toContain('Welcome to React components')
+      expect(node.innerHTML).toContain('Prev')
     })
   })
 })