Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jedib0t committed Apr 22, 2024
1 parent 9ad01d1 commit cac5da0
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@
Passphrase & Password generation library for GoLang.

## Passphrases

Passphrases are made up of 2 or more words connected by a separator and may have
capitalized words, and numbers. These are easier for humans to remember compared
to passwords.

```golang
g, err := passphrase.NewGenerator(
passphrase.WithCapitalizedWords(true),
Expand Down Expand Up @@ -41,6 +46,11 @@ Passphrase # 10: "Mirks6-Woofer-Lase"
</details>

## Passwords

Passwords are a random amalgamation of characters and follow certain rules. For
ex., it could have at least 1 upper-case character, 3 lower-case characters, and
a symbol.

```golang
g, err := password.NewGenerator(
password.WithCharset(charset.AllChars.WithoutAmbiguity().WithoutDuplicates()),
Expand Down Expand Up @@ -74,6 +84,11 @@ Password # 10: "kmQVb&fPqexj"

## Odometer

Odometer helps generate all possible combinations of strings given a list of
characters/runes and the expected length of the string. The odometer package
also implements methods to efficiently move forwards and backwards through the
possible combinations.

```golang
o := odometer.New(charset.AlphabetsUpper, 8)

Expand Down

0 comments on commit cac5da0

Please sign in to comment.