add readme

This commit is contained in:
Timo Hocker 2020-03-06 08:38:14 +01:00
parent 1f1bc45499
commit 71dd4f1164

12
README.md Normal file
View File

@ -0,0 +1,12 @@
# Password Helper
ensuring secure password storage on the server side
```js
const password_helper = require('@scode/password-helper');
const hash = await password_helper.hash('foo');
await password_helper.verify(hash, 'foo'); // returns true;
await password_helper.verify(hash, 'bar'); // returns false;
```