node-mpw - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

		{
		"name": "node-mpw",
		"version": "0.1.0",
		"version": "0.1.1",
		"description": "Implementation of Master Password for nodejs and browser",
		@@ -5,0 +5,0 @@ "main": "./dist/index.js",

README.md

		@@ -8,2 +8,12 @@ # node-mpw

		Requirements:

		- Node.js (v4.0.0+)

		Note: this package uses `scrypt` which is built with `node-gyp` so you might need to compile C code. Blame `node-gyp`.

		First, install Node.js, and then open a terminal and run `node -v` and `npm -v` to make sure Node is installed correctly.

		Now we can install the package.

		```bash
		@@ -13,8 +23,17 @@ $ npm install --save node-mpw

		## Usage
		Once it's installed and in your `node_modules` folder, you can now run the script! Here's an example:

		```js
		import mpw from 'node-mpw'

		const username = 'username'
		const password = 'password'
		const site = 'example.com'

		const key = mpw.generateKey(username, password)
		const generated = mpw.generatePassword(site, key, 1, 'long', 3)
		```

		## API Reference

		### generateKey
		@@ -52,11 +71,5 @@

		## To-Do List

		- ~~Clean up code and write documentation~~ Done!
		- ~~Refine algorithm & public API to make it compatible with [Master Password app](https://ssl.masterpasswordapp.com/).~~ Done!
		- Publish as npm package

		## Contributing

		Issues and Pull Requests are welcome! Please read our contributing guidelines & code of conduct beforehand.
		Issues and Pull Requests are welcome! Please read our [Contributing Guidelines](https://github.com/blvdgroup/guidelines) & [Code of Conduct](CONDUCT.md) beforehand.

		@@ -63,0 +76,0 @@ ### Reading the commit log

New alerts