Minor example update in README.md and doc.go

adrg · Oct 31, 2024 · 88111eb · 88111eb
1 parent d9f76be
commit 88111eb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -207,6 +207,9 @@ func main() {
 	// ConfigFile takes one parameter which must contain the name of the file,
 	// but it can also contain a set of parent directories. If the directories
 	// don't exist, they will be created relative to the base config directory.
+	// It is recommended for files to be saved inside an application directory
+	// relative to the base directory rather than directly inside the base
+	// directory (e.g. `appname/config.yaml` instead of `appname-config.yaml`).
 	configFilePath, err := xdg.ConfigFile("appname/config.yaml")
 	if err != nil {
 		log.Fatal(err)

diff --git a/doc.go b/doc.go
@@ -48,6 +48,9 @@ XDG Base Directory
 		// ConfigFile takes one parameter which must contain the name of the file,
 		// but it can also contain a set of parent directories. If the directories
 		// don't exist, they will be created relative to the base config directory.
+		// It is recommended for files to be saved inside an application directory
+		// relative to the base directory rather than directly inside the base
+		// directory (e.g. `appname/config.yaml` instead of `appname-config.yaml`).
 		configFilePath, err := xdg.ConfigFile("appname/config.yaml")
 		if err != nil {
 			log.Fatal(err)