Merge a36c0ce into 0905484

README.md

@@ -1,3 +1,39 @@
-# linear-progress
+# MaterialR LinearProgress
+
+**@materialr/linear-progress**
+
+[![Build Status](https://travis-ci.org/materialr/linear-progress.svg?branch=master)](https://travis-ci.org/materialr/linear-progress)
+[![Coverage Status](https://coveralls.io/repos/github/materialr/linear-progress/badge.svg?branch=master)](https://coveralls.io/github/materialr/linear-progress?branch=master)
+[![NSP Status](https://nodesecurity.io/orgs/materialr/projects/f36d8424-6770-4725-8ff0-b9b45f30d3ec/badge)](https://nodesecurity.io/orgs/materialr/projects/f36d8424-6770-4725-8ff0-b9b45f30d3ec)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 Material linear-progress implementation for React
+
+## Installation
+
+```sh
+$ npm install --save @materialr/linear-progress
+```
+
+## Demo
+
+A full demo is available on the
+[MaterialR website](https://materialr.github.io/components/linear-progress) showcasing all variants.
+
+## Components
+
+### Default export
+
+```js
+import LinearProgress from '@materialr/linear-progress';
+```
+
+**Props**
+
+| Prop            | Type            | Required | Default   | Description                                          |
+| --------------- | --------------- | -------- | --------- | ---------------------------------------------------- |
+| `buffer`        | number (0-1)    | No       | 0         | The total buffer amount                              |
+| `className`     | string          | No       | undefined | Additional classNames to add                         |
+| `indeterminate` | bool            | No       | false     | Whether the progress bar is indeterminate            |
+| `progress`      | number (0-1)    | No       | 0         | The total progress amount                            |
+| `reversed`      | bool            | No       | false     | Whether the progress bar is reversed                 |

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "build:production": "babel src --out-dir lib --ignore **/*.test.js,**/*.test.jsx",
     "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls",
-    "lint": "eslint --ext .js .",
+    "lint": "eslint --ext .js --ext .jsx .",
     "semantic-release": "semantic-release",
     "test": "npm run lint && npm run test:vulnerabilities && npm run test:scripts",
     "test:scripts": "jest --coverage --config ./jest.config.json",
@@ -19,7 +19,7 @@
   "keywords": [
     "React",
     "Material",
-    "Toolbar"
+    "Progress"
   ],
   "author": "Hendrik Volschenk <righteous.trespasser@gmail.com>",
   "license": "MIT",
@@ -28,14 +28,14 @@
   },
   "homepage": "https://github.com/materialr/linear-progress#readme",
   "dependencies": {
-    "@material/linear-progress": "^0.34.0",
+    "@material/linear-progress": "^0.35.0",
     "classnames": "^2.2.5",
     "prop-types": "^15.6.1",
-    "react": "^16.3.1"
+    "react": "^16.3.2"
   },
   "devDependencies": {
     "babel-cli": "^6.26.0",
-    "babel-core": "^6.26.0",
+    "babel-core": "^6.26.3",
     "babel-jest": "^22.4.3",
     "babel-preset-env": "^1.6.1",
     "babel-preset-react": "^6.24.1",
@@ -50,7 +50,7 @@
     "eslint-plugin-react": "^7.7.0",
     "jest": "^22.4.3",
     "nsp": "^3.2.1",
-    "react-dom": "^16.3.1",
+    "react-dom": "^16.3.2",
     "semantic-release": "^15.1.7"
   }
 }