docs: Add config file documentation

.pre-commit-config.yaml

@@ -16,3 +16,9 @@ repos:
         entry: go run ./internal/generate/docs
         language: system
         pass_filenames: false
+      - id: config-example
+        name: config-example
+        entry: go run ./internal/generate/config
+        language: system
+        types: [go]
+        pass_filenames: false

README.md

@@ -103,6 +103,15 @@ Womanhood6-Capsize-Zigzagged
 Unwomanly-Unwashed1-Urchin
 ```
 
+## Configuration
+
+A configuration file will be generated the first time pwgen-go is run. Depending on your operating system, the file will be available at:
+- **Windows:** `%AppData%\pwgen-go\config.toml`
+- **macOS:** `~/Library/Application Support/pwgen-go/config.toml`
+- **Linux:** `~/.config/pwgen-go/config.toml`
+
+An example configuration is also available at [`config_example.toml`](config_example.toml).
+
 ## Templating
 
 Templated passphrases are generated using Go's [text/template](https://pkg.go.dev/text/template) package.

config_example.toml

@@ -0,0 +1,6 @@
+# Number of passphrases to generate.
+count = 10
+# Template used to generate passphrases.
+template = '{{ wordsWithNumber 3 | join "-" | title }}'
+# Wordlist to use. (one of: long, short1, short2)
+wordlist = 'long'

internal/generate/config/main.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"os"
+
+	"github.com/gabe565/pwgen-go/internal/config"
+	"github.com/pelletier/go-toml/v2"
+)
+
+func main() {
+	f, err := os.Create("config_example.toml")
+	if err != nil {
+		panic(err)
+	}
+
+	encoder := toml.NewEncoder(f)
+	conf := config.NewDefault()
+	if err := encoder.Encode(conf); err != nil {
+		panic(err)
+	}
+}