typewriting - npm Package Compare versions

Comparing version 1.2.2 to 1.2.3

package.json

 {
   "name": "typewriting",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "TypeWriting.js is a javascript library to make a typewriter effect.",
+  "scripts": {
+    "dist": "gulp"
+  },
   "repository": {
@@ -9,3 +12,3 @@ "type": "git",
   },
-  "main": "build/typewriting.min.js",
+  "main": "dist/typewriting.min.js",
   "keywords": [
@@ -17,4 +20,14 @@ "typewriter",
   ],
-  "author": "Eddie Wen <[e-mail]> (http://eddiewen.me)",
-  "homepage": "https://github.com/EddieWen-Taiwan/TypeWriting.js#readme"
+  "author": "Eddie Wen <[e-mail]> (http://eddiewen.me)",
+  "license": "MIT",
+  "homepage": "https://github.com/EddieWen-Taiwan/TypeWriting.js#readme",
+  "dependencies": {},
+  "devDependencies": {
+    "babel-cli": "^6.22.2",
+    "babel-preset-es2015": "^6.22.0",
+    "gulp": "^3.9.1",
+    "gulp-babel": "^6.1.2",
+    "gulp-rename": "^1.2.2",
+    "gulp-uglify": "^2.0.1"
+  }
 }

README.md

 ## TypeWriting.js
 
-[GitHub repo](https://github.com/EddieWen-Taiwan/TypeWriting.js) / [DEMO](http://github.eddiewen.me/TypeWriting.js/)
+![https://unsplash.com/photos/E0Spm6XXn2Y](cover.jpg)
 
+If you want to make the typing effect, this is what you need.
+
+[TypeWriting DEMO](http://github.eddiewen.me/TypeWriting.js/)
+
 _Note: TypeWriting.js doesn't depend on jQuery since version 1.2. If you want to keep the old version, please check another branch - [jQuery-v1.1.3](https://github.com/EddieWen-Taiwan/TypeWriting.js/tree/jQuery-v1.1.3)._
 
 ----
+### Installation
 
+Just clone or download the zip of this repository
+
+or via [npm](https://www.npmjs.com/package/typewriting):
+
+~~~bash
+$ npm install --save typewriting
+# or
+$ yarn add typewriting
+~~~
+
 ### Setup
@@ -13,3 +28,3 @@
 <!-- just typewriting.js or .min.js -->
-<script type="text/javascript" src="path/to/typewriting.min.js"></script>
+<script src='path/to/typewriting.min.js'></script>
 ~~~
@@ -24,4 +39,2 @@
 
-I use the height of targetElement to set the cursor height. You could use its line-height to control cursor height.
-
 ----
@@ -42,13 +55,15 @@
 
+I use the height of targetElement to set the cursor height. You could use its line-height to control cursor height.
+
 Second parameter is the function after typing effect.
 
 ~~~javascript
-var typeWriting = new TypeWriting({
-	targetElement	: document.getElementsByClassName('terminal')[0],
-	inputString		: 'Hello, world.',
-	typing_interval	: 130,
-	blink_interval	: '1s',
-	cursor_color	: '#00fd55',
-}, function() {
-	console.log("END");
+const typeWriting = new TypeWriting({
+	targetElement   : document.getElementsByClassName('terminal')[0],
+	inputString     : 'Hello, world.',
+	typing_interval : 130,
+	blink_interval  : '1s',
+	cursor_color    : '#00fd55',
+}, () => {
+	console.log('END');
 });
@@ -62,12 +77,5 @@ ~~~
 ~~~javascript
-typeWriting.rewrite( "This is TypeWriting.js", function() {
-	console.log("Rewrite is finished");
+typeWriting.rewrite('Welcome to TypeWriting.js', () => {
+	console.log('Rewrite() is finished');
 });
 ~~~
-
-----
-
-### Author
-
-Eddie Wen: <[e-mail]>  
-GitHub: <https://github.com/EddieWen-Taiwan>

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

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

339798

increased by3272.02%

Number of package files

10

increased by100%

Number of low license alerts

0

decreased by-100%

Lines of code

233

increased by6.39%

Number of lines in readme file

78

increased by13.04%

Worsened metrics

Dev dependency count

6

increased byInfinity%

No dependency changes