UNPKG

2.69 kBMarkdownView Raw
1# htdigest
2[Node.js](http://nodejs.org/) package for HTTP Digest Authentication password file utility.
3
4[![Build Status](https://api.travis-ci.org/gevorg/htdigest.png)](https://travis-ci.org/gevorg/htdigest)
5[![Dependency Status](https://david-dm.org/gevorg/htdigest.png)](https://david-dm.org/gevorg/htdigest)
6
7## Installation
8
9Via git (or downloaded tarball):
10
11```bash
12$ git clone git://github.com/gevorg/htdigest.git
13```
14Via [npm](http://npmjs.org/):
15
16```bash
17$ npm install -g htdigest
18```
19## Usage
20
21```bash
22$ htdigest [-c] passwordfile realm username
23```
24
25## Options
26
27 - `-c` - Create a new file.
28
29## Running tests
30
31It uses [nodeunit](https://github.com/caolan/nodeunit/), so just run following command in package directory:
32
33```bash
34$ npm test
35```
36
37## Issues
38
39You can find list of issues using **[this link](http://github.com/gevorg/htdigest/issues)**.
40
41## Requirements
42
43 - **[Node.js](http://nodejs.org)** - Event-driven I/O server-side JavaScript environment based on V8.
44 - **[npm](http://npmjs.org)** - Package manager. Installs, publishes and manages node programs.
45
46## Dependencies
47
48 - **[commander](https://github.com/visionmedia/commander.js/)** - node.js command-line interfaces made easy.
49 - **[prompt](https://github.com/flatiron/prompt)** - a beautiful command-line prompt for node.js.
50
51## Development dependencies
52
53 - **[coffee-script](http://coffeescript.org/)** - CoffeeScript is a little language that compiles into JavaScript.
54 - **[nodeunit](https://github.com/caolan/nodeunit/)** - Easy unit testing in node.js and the browser, based on the assert module.
55
56## License
57
58The MIT License (MIT)
59
60Copyright (c) 2015 Gevorg Harutyunyan
61
62Permission is hereby granted, free of charge, to any person obtaining a copy of
63this software and associated documentation files (the "Software"), to deal in
64the Software without restriction, including without limitation the rights to
65use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
66the Software, and to permit persons to whom the Software is furnished to do so,
67subject to the following conditions:
68
69The above copyright notice and this permission notice shall be included in all
70copies or substantial portions of the Software.
71
72THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
73IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
74FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
75COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
76IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
77CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.