<commit_before>![Seneca](http://senecajs.org/files/assets/seneca-logo.png)
> A [Seneca.js](https://github.com/senecajs/) a seneca-auth plugin

# seneca-local-auth

[![npm version][npm-badge]][npm-url]
[![Build Status][travis-badge]][travis-url]
[![Dependency Status][david-badge]][david-url]
[![Gitter chat][gitter-badge]][gitter-url]

Lead Maintainer: [<NAME>](https://github.com/mirceaalexandru)

This plugin is used by [seneca-auth](https://www.npmjs.com/package/seneca-auth) for authenticating via local strategy.
It uses [PassportJS](http://passportjs.org). The [seneca-auth](https://www.npmjs.com/package/seneca-auth) is the
authentication plugin used by [Seneca](http://senecajs.org) toolkit.

For a gentle introduction to Seneca itself, see the [senecajs.org](http://senecajs.org) site.

If you're using this plugin module, feel to contact on twitter if you have any questions! :) [@Alexandru_M](https://twitter.com/Alexandru_M)

- __Version:__ 0.0.3
- __Tested on:__ Seneca 0.8, 0.9
- __Node:__ 4, 5
- __License:__ [MIT][]


## Install

```sh
npm install seneca-local-auth
```

## Using Local Auth

When using seneca-auth the local auth must be initialized using:

```
seneca.use('auth')
seneca.use('local-auth', options)<commit_msg>changes for Readme<commit_after>![Seneca](http://senecajs.org/files/assets/seneca-logo.png)
> A [Seneca.js](https://github.com/senecajs/) a seneca-auth plugin

# seneca-local-auth

[![npm version][npm-badge]][npm-url]
[![Build Status][travis-badge]][travis-url]
[![Dependency Status][david-badge]][david-url]
[![Gitter chat][gitter-badge]][gitter-url]

Lead Maintainer: [<NAME>](https://github.com/mirceaalexandru)

This plugin is used by [seneca-auth](https://www.npmjs.com/package/seneca-auth) for authenticating via local strategy.
It uses [PassportJS](http://passportjs.org). The [seneca-auth](https://www.npmjs.com/package/seneca-auth) is the
authentication plugin used by [Seneca](http://senecajs.org) toolkit.

For a gentle introduction to Seneca itself, see the [senecajs.org](http://senecajs.org) site.

If you're using this plugin module, feel to contact on twitter if you have any questions! :) [@Alexandru_M](https://twitter.com/Alexandru_M)

- __Version:__ 0.1.0
- __Tested on:__ Seneca 0.8, 0.9
- __Node:__ 4, 5
- __License:__ [MIT][]


## Install

```sh
npm install seneca-local-auth
```

## Using Local Auth

When using seneca-auth the local auth must be initialized using:

```
seneca.use('auth')
seneca.use('local-auth', options)
{'fraction_non_alphanumeric': 0.1663318601848132, 'fraction_numerical': 0.007231820008035355, 'mean_word_length': 5.0880195599022, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 10, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1130089', 'n_tokens_mistral': 942, 'n_tokens_neox': 896, 'n_words': 207}