Updates command descriptions and example app details

matzefriedrich · Nov 27, 2024 · d3de1ad · d3de1ad
1 parent 0c2fbbd
commit d3de1ad
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/example/cmd/charmer/charmer.go b/example/cmd/charmer/charmer.go
@@ -10,7 +10,7 @@ import (
 func main() {
 
 	err :=
-		charmer.NewCommandLineApplication("charmer-example", "").
+		charmer.NewCommandLineApplication("charmer-example", "A sample application to showcase the charmer package.").
 			AddCommand(commands.CreateHelloCommand()).
 			AddGroupCommand(commands.CreateCryptCommand(), func(crypto types.CommandSetup) {
 				crypto.AddCommand(

diff --git a/example/commands/crypto_commands.go b/example/commands/crypto_commands.go
@@ -8,9 +8,10 @@ import (
 
 type cryptoCommand struct {
 	types.BaseCommand
-	use types.CommandName `flag:"crypt"`
+	use types.CommandName `flag:"crypt" short:"Provides commands to encrypt and decrypt messages." long:"The command group offers tools for securely encrypting messages and decrypting them with a provided passphrase. Use these commands to ensure message confidentiality and safe data transmission."`
 }
 
+// CreateCryptCommand initializes a new cobra.Command, providing sub-commands for encrypting and decrypting messages.
 func CreateCryptCommand() *cobra.Command {
 	instance := &cryptoCommand{
 		BaseCommand: types.BaseCommand{},