Skip to content

Commit

Permalink
feat (docs): added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sparkenstein committed Oct 12, 2020
1 parent c4526a1 commit 8626cdf
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# passgen

A simple random password generator.

## Usage
```
passgen 1.0
@Sparkenstein
Generate Random password on command line
USAGE:
passgen [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-i, --include <include> include numbers/upppercase/lowercase/symbols in generated string [default: nlus]
-l, --length <length> include lowercase characters in generated string [default: 16]
```

## Example

Generate random password with default settings (16 char long string with number, lowercase, uppercase, and symbols):
```
passgen
```

Change length of password to 20 chars:
```
passgen -l 20
```

Use only Lowercase and Uppercase characters
```
passgen -i lu
```

Generate only number, symbols and uppercase with length of 25
```
passgen -l 25 -i nsu
```

0 comments on commit 8626cdf

Please sign in to comment.