Skip to content

Commit

Permalink
Touch up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adalinesimonian committed Jun 22, 2015
1 parent ea60fc2 commit 362f4b3
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## node-adauth

Fork of [node-ldapauth-fork](https://github.com/vesse/node-ldapauth-fork) targeted towards use with an Active Directory domain.
Fork of [node-ldapauth-fork](https://github.com/vesse/node-ldapauth-fork)
targeted towards use with an Active Directory domain.

## Usage

Expand All @@ -17,17 +18,18 @@ auth.close(function(err) { ... })

## Install

npm install adauth
$ npm install adauth


## License

MIT. See "LICENSE" file.


## `ADAuth` Config Options
## Configuration

[Use the source Luke](https://github.com/vsimonian/node-adauth/blob/master/lib/adauth.js#L25-104)
[Use the source Luke](
https://github.com/vsimonian/node-adauth/blob/master/lib/adauth.js#L25-110)


## express/connect basicAuth example
Expand All @@ -48,7 +50,8 @@ var config = {

var ad = new ADAuth(config.ad);

var basicAuthMiddleware = connect.basicAuth(function (username, password, callback) {
var basicAuthMiddleware = connect.basicAuth(
function (username, password, callback) {
ad.authenticate(username, password, function (err, user) {
if (err) {
console.log("AD auth error: %s", err);
Expand Down

0 comments on commit 362f4b3

Please sign in to comment.