Skip to content

fix(docs): correct config file paths in README#427

Open
clarabennettdev wants to merge 1 commit intocharmbracelet:mainfrom
clarabennettdev:fix/readme-config-paths
Open

fix(docs): correct config file paths in README#427
clarabennettdev wants to merge 1 commit intocharmbracelet:mainfrom
clarabennettdev:fix/readme-config-paths

Conversation

@clarabennettdev
Copy link

Summary

The README listed user config dir paths with a wishlist/ subdirectory:

[[user config dir]]/wishlist/config.yaml
[[user config dir]]/wishlist/config.yml
[[user config dir]]/wishlist/config

But the actual code in cmd/wishlist/main.go (userConfigPaths()) places config files directly in the user config dir:

[[user config dir]]/wishlist.yaml
[[user config dir]]/wishlist.yml
[[user config dir]]/wishlist

This also matches the output of wishlist --help.

Fixes #410

The README listed user config dir paths as:
  [[user config dir]]/wishlist/config.yaml
  [[user config dir]]/wishlist/config.yml
  [[user config dir]]/wishlist/config

But the actual code in cmd/wishlist/main.go uses:
  [[user config dir]]/wishlist.yaml
  [[user config dir]]/wishlist.yml
  [[user config dir]]/wishlist

This matches the output of 'wishlist --help'.

Fixes charmbracelet#410
@clarabennettdev clarabennettdev requested a review from a team as a code owner February 16, 2026 16:06
@clarabennettdev clarabennettdev requested review from aymanbagabas and meowgorithm and removed request for a team February 16, 2026 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant