creepyface - npm Package Compare versions

Comparing version 7.2.2 to 7.2.3

package.json

 {
   "name": "creepyface",
-  "version": "7.2.2",
+  "version": "7.2.3",
   "main": "dist/creepyface.umd.js",
@@ -63,3 +63,3 @@ "types": "dist/creepyface.d.ts",
   },
-  "gitHead": "8e7a2511ef2f644a6bfc91ad2df36c35d7b8233c"
+  "gitHead": "c12af5681c82962e4c6a3e8f535d9d9a42ffbcb1"
 }

README.md

 # [Creepyface](https://creepyface.io) · [![npm version](https://img.shields.io/npm/v/creepyface.svg?style=flat)](https://www.npmjs.com/package/creepyface)
 
-This is the core library. The documentation is in the [root README](../../README.md).
+**For the full documentation go to the [root README](../../README.md).**
 
+Creepyface is a little JavaScript library that makes your face look at the pointer.
+
+See it in action at [creepyface.io](https://creepyface.io) and create your own one using [the wizard](https://creepyface.io/create).
+
+![Example animated gif of a face looking at the pointer](../../example.gif)
+
+## Usage
+
+```html
+<script src="https://creepyface.io/creepyface.js"></script>
+
+<img
+  data-creepyface
+  src="https://creepyface.io/img/0/serious"
+  data-src-hover="https://creepyface.io/img/0/hover"
+  data-src-look-0="https://creepyface.io/img/0/0"
+  data-src-look-45="https://creepyface.io/img/0/45"
+  data-src-look-90="https://creepyface.io/img/0/90"
+  data-src-look-135="https://creepyface.io/img/0/135"
+  data-src-look-180="https://creepyface.io/img/0/180"
+  data-src-look-225="https://creepyface.io/img/0/225"
+  data-src-look-270="https://creepyface.io/img/0/270"
+  data-src-look-315="https://creepyface.io/img/0/315"
+/>
+```
+
 ## Developing
@@ -6,0 +32,0 @@

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

34463

increased by2.72%

Number of lines in readme file

35

increased by288.89%

No dependency changes