react-customscroll - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "react-customscroll",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "This is little component for custom scroll in React",
@@ -5,0 +5,0 @@ "main": "dist/customscroll.js",

README.md

@@ -16,4 +16,27 @@ # React Custom Scroll
 
-Example:
+[Example](http://natrube.net/custom-scroll/index.html)
 
-[Example](http://natrube.net/custom-scroll/index.html)
+## How usage
+
+### Step 1:
+```
+npm install react-customscroll -save
+```
+
+### Step 2:
+
+Inject component on your page:
+import 'react-customscroll/dist/styles.css';
+import CustomScroll from 'react-customscroll';
+
+### Step 3:
+Paste CustomScroll component inside wrapper block with height and overlow: hidden
+For example:
+```
+<div style={{height: '500px', overflow: 'hidden'}}>
+  <CustomScroll>
+    ...
+  </CustomScroll>
+</div>
+```
+See more examples in <strong>example/index.html</strong>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2483443

increased by0.02%

Number of lines in readme file

41

increased by127.78%

No dependency changes