Add example app (#4)

.gitignore

@@ -0,0 +1 @@
+/cmd/example1/example1

README.md

@@ -20,7 +20,9 @@ The `go-phings/broccli` package simplifies command line interface management. It
 * [Features + Roadmap](#features)
 
 ## Sample code
-The following code snippet from another tiny project shows how the module can be used.
+Example dummy application can be found in `cmd/example1` directory.
+
+However, the following code snippet from another tiny project shows how the module can be used.
 
 ```go
 // create new CLI object

cmd/example1/hellos.txt

@@ -0,0 +1,5 @@
+Hi:Hello
+Cześć:Dzień dobry
+Halo:Guten Tag
+Hei:Tere
+Moi:Hyvää päivää

cmd/example1/main.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"os"
+	"strings"
+
+	rand "math/rand/v2"
+
+	"github.com/go-phings/broccli"
+)
+
+func main() {
+	cli := broccli.NewCLI("example1", "Example app", "[email protected]")
+
+	printCmd := cli.AddCmd("print", "Prints a hello message", printHandler)
+
+	printCmd.AddArg("first-name", "FIRST_NAME", "First name of the person to welcome", broccli.TypeString, broccli.IsRequired)
+	printCmd.AddArg("last-name", "LAST_NAME", "Optional last name", broccli.TypeString, 0)
+
+	printCmd.AddFlag("language-file", "l", "PATH_TO_FILE", "File containing 'hello' in many languages", broccli.TypePathFile, broccli.IsRegularFile|broccli.IsExistent|broccli.IsRequired)
+	printCmd.AddFlag("alternative", "a", "", "Use alternative welcoming", broccli.TypeBool, 0)
+
+	os.Exit(cli.Run())
+}
+
+func printHandler(c *broccli.CLI) int {
+	langFile := c.Flag("language-file")
+	file, err := os.Open(langFile)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "error opening file %s: %s", langFile, err.Error())
+		return 1
+	}
+
+	var lines []string
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+			line := scanner.Text()
+			if line != "" {
+				lines = append(lines, line)
+			}
+	}
+
+	i := rand.IntN(len(lines)-1)
+	messageArr := strings.Split(lines[i], ":")
+	message := messageArr[0]
+	if c.Flag("alternative") == "true" {
+		message = messageArr[1]
+	}
+
+	firstName := c.Arg("first-name")
+	lastName := ""
+	if c.Arg("last-name") != "" {
+		lastName = fmt.Sprintf(" %s", c.Arg("last-name"))
+	}
+
+	fmt.Fprintf(os.Stdout, "%s, %s%s!", message, firstName, lastName)
+
+	return 0
+}

version.go

@@ -1,3 +1,3 @@
 package broccli
 
-const VERSION = "2.1.2"
+const VERSION = "2.1.3"