Dependencies bump and small docs addition

fromtheoutfit · Oct 8, 2020 · ed97530 · ed97530
1 parent c4b6a6f
commit ed97530
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -6,8 +6,9 @@ https://theoutfit-fadable.netlify.app/
 
 ## How to Implement
 1. Install it: `npm i @theoutfit/fadable --save`
-2. Call it: `fadable()`
-3. Class it: add a class of `fadable` to any element
+2. Import it: <code>import fadable from '@theoutfit/fadable'</code>
+3. Call it: `fadable()`
+4. Class it: add a class of `fadable` to any element
 
 ## Configuration
 Property | Type | Default | Description

diff --git a/demo/index.html b/demo/index.html
@@ -8,7 +8,7 @@
   </head>
   <body>
     <main>
-      
+
       <section class="fadable">
         <div>
           <h1>Fadable</h1>
@@ -44,6 +44,7 @@ <h1>This box <em>probably</em> faded in</h1>
           <h1>Add Fadable to your project</h1>
           <ol>
             <li>Install it: <kbd>npm i @theoutfit/fadable --save</kbd></li>
+            <li>Import it: <code>import fadable from '@theoutfit/fadable'</code></li>
             <li>Call it: <code>fadable()</code></li>
             <li>Class it: add a class of <code>fadable</code> to any element</li>
           </ol>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@theoutfit/fadable",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Fade in elements as they move into view, at both the bottom and top of the viewport.",
   "main": "dist/fadable.min.js",
   "scripts": {
@@ -12,16 +12,21 @@
     "type": "git",
     "url": "git+https://github.com/fromtheoutfit/fadable.git"
   },
-  "keywords": ["fade-in", "fade-out", "fade", "fades"],
+  "keywords": [
+    "fade-in",
+    "fade-out",
+    "fade",
+    "fades"
+  ],
   "author": "The Outfit, Inc.",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fromtheoutfit/fadable/issues"
   },
   "homepage": "https://github.com/fromtheoutfit/fadable/#readme",
   "devDependencies": {
-    "rollup": "^2.26.4",
-    "rollup-plugin-terser": "^7.0.0"
+    "rollup": "^2.29.0",
+    "rollup-plugin-terser": "^7.0.2"
   },
   "files": [
     "dist"