README.md

# erlPass

![build](https://github.com/thetelefon/erlPass/actions/workflows/erlang.yml/badge.svg)
[![codecov](https://codecov.io/gh/thetelefon/erlPass/branch/master/graph/badge.svg?token=GWYPMBYL96)](https://codecov.io/gh/thetelefon/erlPass)
![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)


An OTP library to generate passwords.

## Installation

Add erlPass to your rebar.config:

```
{deps, [
    erlPass
    ]}.
```

## Build

    $ rebar3 compile


## Test

Simply run eunit with rebar3

    $ rebar3 eunit


## Usage

Simple to use, just call the `generate/2` function with the 

desired attributes in list.

### Example

```
1> erlPass:generate(10, [upper,number,symbol]).
"4A0LE6\\_W@"
2> 
```

#### ***Deprecated***

```
1> erlPass:generate(10, true, true, false, true).
"mfNAA}$S,^"
2> 
```