skinview3d - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
 	"name": "skinview3d",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Three.js powered Minecraft skin viewer",
@@ -9,2 +9,3 @@ "main": "src/skinview3d.js",
 		"build-babel": "./node_modules/.bin/rollup -c rollup.config.babel.js",
+		"prepare": "rm -rf build && npm run build && npm run build-babel",
 		"test": "echo \"Error: no test specified\" && exit 1"
@@ -11,0 +12,0 @@ },

README.md

@@ -1,2 +0,7 @@
-# skinview3d
+skinview3d
+========
+
+[![Latest NPM release][npm-badge]][npm-badge-url]
+[![License][license-badge]][license-badge-url]
+
 Three.js powered Minecraft skin viewer.
@@ -10,2 +15,38 @@
 
+# Usage
+```html
+<div id="skin_container"></div>
+<script>
+	let skinViewer = new skinview3d.SkinViewer({
+		domElement: document.getElementById("skin_container"),
+		slim: true,
+		width: 600,
+		height: 600,
+		skinUrl: "img/skin.png",
+		capeUrl: "img/cape.png",
+		animation: skinview3d.WalkAnimation
+	});
+
+	// change the skin and cape
+	// skinViewer.skinUrl = "img/skin.png";
+	// skinViewer.capeUrl = "img/cape.png";
+
+	// change the width and height
+	// skinViewer.width = 300;
+	// skinViewer.height = 400;
+
+	// enable the mouse control feature
+	let control = new skinview3d.SkinControl(skinViewer);
+
+	// pause the animation
+	// skinViewer.animationPaused = true;
+
+	// change the animation speed
+	// skinViewer.animationSpeed = 8;
+
+	// disable the 'right click to play/pause' feature
+	// control.enableAnimationControl = false;
+</script>
+```
+
 # Build
@@ -16,3 +57,6 @@ `npm run build` Concatenation only.
 
-# License
-The repository is licensed under GPL-3.0 License.
+
+[npm-badge]: https://img.shields.io/npm/v/skinview3d.svg
+[npm-badge-url]: https://www.npmjs.com/package/skinview3d
+[license-badge]: https://img.shields.io/npm/l/skinview3d.svg
+[license-badge-url]: ./LICENSE

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

608888

increased by596.72%

Number of package files

19

increased by18.75%

Lines of code

5585

increased by384.39%

Number of lines in readme file

61

increased by258.82%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes