sha512-crypt-ts - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

package.json

 {
   "name": "sha512-crypt-ts",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Typescript wrapper for SHA-512, including $6$ crypt format.",
@@ -5,0 +5,0 @@ "scripts": {

README.md

 [![codecov](https://codecov.io/gh/bedlaj/sha512-crypt-ts/branch/master/graph/badge.svg)](https://codecov.io/gh/bedlaj/sha512-crypt-ts)
 ![Build](https://github.com/bedlaj/sha512-crypt-ts/workflows/Build/badge.svg)
 ![Test and publish](https://github.com/bedlaj/sha512-crypt-ts/workflows/Test%20and%20publish/badge.svg)
-# sha512-ts
-WIP
+# SHA-512-crypt-ts
+Crypt compatible ES5 implementation inspired by [mvo5/sha512crypt-node](https://github.com/mvo5/sha512crypt-node)
+
+# Installation
+Install [NPM package](https://www.npmjs.com/package/sha512-crypt-ts)
+```
+npm install --save sha512-crypt-ts
+```
+Import module
+```
+import { sha512 } from 'sha512-crypt-ts';
+```
+Usage
+```
+sha512.sha512crypt('password', 'saltsalt'); // Returns $6$saltsalt$qFmFH.bQmmtXzyBY0s9v7Oicd2z4XSIecDzlB5KiA2/jctKu9YterLp8wwnSq.qc.eoxqOmSuNp2xS0ktL3nh/
+```
+Another examples can be found in [unit tests](https://github.com/bedlaj/sha512-crypt-ts/blob/master/tests/sha512.test.ts) or in peer project [bedlaj/unifi-reset-password](https://github.com/bedlaj/unifi-reset-password/blob/master/src/app/app.component.ts).

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

27202

increased by2.77%

Number of lines in readme file

21

increased by250%

No dependency changes