Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bollos00 committed Dec 15, 2021
1 parent 5334a47 commit 460a0ac
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
$ ./passwgen-go --help
Usage of ./passwgen-go:
-c, --characters="1aA%": Allowed characters type on the password
-C, --clipboard=false: Copy the generated password to the clipboard instead of printing it
-i, --ignored="": Characters ignored in the creation of the password
-l, --length=-1: Fixed length of the password (overwrites 'min' and 'max' flags)
-M, --max=16: Maximum size of the password
Expand Down Expand Up @@ -93,4 +94,16 @@ $ passwgen-go -l 50
* Generates a password with fixed length of 6 with only numbers
```
$ passwgen-go -l 6 -c "1"
```

## Clipboard

The generated password can be given to the user with two different forms:

* By printing it into the console (default);
* By transferring it into the clipboard.

In order to copy the password into the clipboard, you may use the `-C` flag, as shown below:
```
$ passwgen-go -C
```
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func initFlags() passwgen.PasswGen {
var ignoredChars *string = flag.StringP("ignored", "i", "",
"Characters ignored in the creation of the password")
var copyClipboard *bool = flag.BoolP("clipboard", "C", false,
"Copy the generated password to the clipboard and do not print it")
"Copy the generated password to the clipboard instead of printing it")

flag.Parse()

Expand Down

0 comments on commit 460a0ac

Please sign in to comment.