diff --git a/README.md b/README.md new file mode 100644 index 0000000..e90df79 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +pwgenr +==== +[![Crates.io](https://img.shields.io/crates/v/pwgenr.svg)](https://crates.io/crates/pwgenr) + +Random password generator (mainly for use with a password manager). + +## Example +```bash +$ pwgenr -lc box -- 12 6 +◭┫▹◨┒◳┟┰┒┴┷○ +╓┭◷▱╙▙╼○▒┆◌╰ +▯◳▥◱◛═▉◆┴◽▌╓ +◶◓┆│┓╰┶◑▶◉◁┓ +┶┬◪◶◞┼▰▏┞╳╋▩ +▌┖╅┺┶◫┺┹◪┲┧┦ +``` + +## Options + +You can check by typing `pwgenr -h`: + +``` +USAGE: + pwgenr [FLAGS] [OPTIONS] [--] [ARGS] + +FLAGS: + -a, --ascii Only use ASCII characters + -b, --clipboard Copy first password to clipboard (requires xclip) + -h, --help Prints help information + -l, --list Print the generated passwords in a list (default: columns) + -v Set the logging level + -V, --version Prints version information + +OPTIONS: + -c ... Categories to be used [values: ascii, symbols, math, arrows, dingbat, games, box, tech] + -s, --column-separator Separator between columns [default: ] + +ARGS: + The length of the generated passwords [default: 64] + How many passwords should be generated [default: 12] +``` + +## Installation + +You can use the `cargo install` command: + + $ cargo install pwgenr + +or a classic build and run: + +```bash +$ git clone https://gitlab.com/Sakuhl/pwgenr +$ cd pwgenr +$ cargo build --release +$ cp target/release/pwgenr ~/.bin # assuming .bin is in your path +``` \ No newline at end of file