Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #11

Merged
merged 2 commits into from
Sep 15, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,27 @@ Retrieve password for user
`npm install @iiddoo/aim-password-retrieve`

## Usage

```javascript
const retriever = require('@iiddoo/aim-password-retrieve');

const pwd = retriever('user');


Output should be `password`

// ES6 async\await
(async () => {
try {
const pwd = await retriever('user');
} catch (error) {
// error handle
}
})();

// Promise
retriever('user')
.then((result) => {
const pwd = result;
})
.catch((error) => {
// error handle
})
```

## Tests

Expand Down