Skip to content

Commit

Permalink
Updates documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lkrnac committed Nov 12, 2014
1 parent 52421ee commit 090fd6b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
13 changes: 12 additions & 1 deletion README.md
Expand Up @@ -7,7 +7,18 @@
[![license](http://img.shields.io/npm/l/jasstor.svg)](http://img.shields.io/npm/l/jasstor.svg)
[![NPM](https://nodei.co/npm/jasstor.png)](https://nodei.co/npm/jasstor/)

JSON credentials storage and authentication. Passwords are hashed with [bcrypt](https://github.com/ncb000gt/node.bcrypt.js).
Node.JS module. Simple file storage for credentials.

## Features
- Stores credentials (user, hashed password) and role name into JSON file
- Handles verification of given username and password
- Reads role for given user
- Passwords are hashed with [bcrypt](https://github.com/ncb000gt/node.bcrypt.js)

## Installation
```Shell
npm install jasstor
```

## Getting Started
```javascript
Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -2,7 +2,7 @@
"name": "jasstor",
"version": "0.0.2",
"main": "dist/jasstor.js",
"description": "Stores credentials into JSON file and authenticate",
"description": "Simple file storage for credentials",
"homepage": "https://github.com/lkrnac/jasstor",
"bugs": "https://github.com/lkrnac/jasstor/issues",
"author": {
Expand Down

0 comments on commit 090fd6b

Please sign in to comment.