browser-signature - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

browser-signature.d.ts

@@ -1,1 +0,1 @@
-declare module 'browser-signature';
+declare module 'browserSignature';

package.json

 {
   "name": "browser-signature",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Browser unique signature (Fingerprint) generator",
@@ -42,5 +42,6 @@ "source": "src/index.js",
     "*.d.ts",
-    "dist"
+    "dist",
+    "src"
   ],
   "types": "browser-signature.d.ts"
 }

README.md

@@ -1,2 +0,61 @@
-# browser-signature
+# Browser Signature
 Browser unique signature (Fingerprint) generator
+
+This is a simple and tiny (<1kb) package for generating unique user browser signature or fingerprint.
+
+The package allow you to identify user online using their browser unique signature
+
+The browser unique fingerprint or signature is generated using the hash of browser mimeTypes count + userAgent string length + global properties count + screen property values
+
+
+Available in four formats:
+
+* **ES Module**: `dist/browser-signature.m.js`
+* **CommonJS**: `dist/browser-signature.js`
+* **ModernJS**: `dist/browser-signature.modern.js`
+* **UMD**: `dist/browser-signature.umd.js`
+
+
+## Install
+
+```
+$ npm install --save browser-signature
+```
+
+## Install Usage
+
+```js
+import browserSignature from 'browser-signature';
+
+const signature = browserSignature();
+
+console.log("Current Browser Unique Signature: ", signature);
+ // Result will look like => 'Current Browser Unique Signature: MjY2NjE4Z3AwMThnbXpvbw=='
+```
+
+## From CDN
+    
+    <script src="https://cdn.jsdelivr.net/npm/browser-signature@1.0.4/dist/browser-signature.umd.js" ></script>
+    or
+    <script src="https://unpkg.com/browser-signature@1.0.4/dist/browser-signature.umd.js"></script>
+    
+
+## From CDN Usage
+
+```js
+
+const signature = browserSignature();
+
+console.log("Current Browser Unique Signature: ", signature);
+ // Result will look like => 'Current Browser Unique Signature: MuY1NjE9b3swpTknbXpvbw=='
+```
+
+## API
+
+### browserSignature()
+Returns: `String`
+
+
+## License
+
+MIT © [Hammed Olalekan Osanyinpeju](https://successtar.github.io)

No alert changes

Improved metrics

Total package byte prevSize

16179

increased by20.69%

Number of package files

13

increased by8.33%

Lines of code

43

increased by230.77%

Number of lines in readme file

62

increased by1966.67%

No dependency changes