diff --git a/README.md b/README.md new file mode 100644 index 0000000..a4f472a --- /dev/null +++ b/README.md @@ -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; +```