From cac5da01f149f7503899439a88ebfcccc3529442 Mon Sep 17 00:00:00 2001 From: Naveen Mahalingam Date: Mon, 22 Apr 2024 12:40:05 -0700 Subject: [PATCH] doc --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 9beb112..13bb41e 100644 --- a/README.md +++ b/README.md @@ -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), @@ -41,6 +46,11 @@ Passphrase # 10: "Mirks6-Woofer-Lase" ## 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()), @@ -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)