docs: update README for auto-generated settings (#40)#43
Merged
Conversation
Updates documentation to reflect the new first-run behavior implemented in PR #41: ## Changes ### Settings section rewritten - Documented zero-config first run experience - Listed auto-generated defaults (keypair, relay, user_mode, etc.) - Explained configuration priority (user dir > portable > auto-generate) - Added note about 0600 file permissions on Unix ### Example settings.toml updated - Removed placeholder values that suggested manual editing - Shows actual defaults used by auto-generation - Added note explaining values are auto-generated ### TODO list - Marked auto-generate feature as complete with issue link ## Related - Closes #40 (via PR #41) - Documents behavior from PR #41
grunch
approved these changes
Mar 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates README documentation to reflect the new first-run behavior implemented in PR #41.
Changes
Settings section rewritten
Before: README said Mostrix copies
settings.tomlfrom project root to~/.mostrix/on first run, requiring manual editing beforehand.After: Documents the new zero-config experience:
relays = ["wss://relay.mostro.network"]user_mode = "user"pow = 0currencies_filter = [](all currencies)npubprinted to stdout0600file permissions on UnixConfiguration priority documented
~/.mostrix/settings.toml— User config directorysettings.tomlnext to executable — Portable mode (USB installs)Example settings.toml updated
TODO list
Related