marquee-line - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "marquee-line",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Marquee and Image crawl",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # marquee-line
+
+## Installing
+
+### Package manager
+
+Using npm:
+
+```bash
+$ npm install marquee-line
+```
+
+Using yarn:
+
+```bash
+$ yarn add marquee-line
+```
+
+JS
+```js
+import marquee from 'marquee-line';
+
+$('.marquee').marquee({
+  mask: '.mask',
+  line: '.line',
+  animSpeed: 30,
+  pauseOnHover: true,
+});
+
+
+Options
+
+mask: null            // masking class which should have overflow hidden
+line: '>*'            // line class which holds the crawling items
+handleFlexible: true, // Boolean
+pauseOnHover: true,   // Boolean
+hoverClass: 'hover',  // hovere class
+direction: 'left',    // left/right
+cloneClass: 'cloned', // clone class
+animSpeed: 10,        // px per second
+initialDelay: 0       // milisecond
+````
+
+HTML
+```html
+<div class="marquee">
+  <div class="mask">
+    <div class="line">
+      <div>Hello</div>
+      <div>Hello</div>
+      <div>Hello</div>
+    </div>
+  </div>
+</div>
+````

No alert changes

Improved metrics

Total package byte prevSize

7890

increased by14.45%

Number of package files

4

increased by33.33%

Lines of code

175

increased by5.42%

Number of lines in readme file

56

increased by2700%

No dependency changes