Skip to content

docs: update README to reflect new architecture and API usage#7

Merged
devspexx merged 1 commit into
masterfrom
docs/readme-architecture-update
Apr 5, 2026
Merged

docs: update README to reflect new architecture and API usage#7
devspexx merged 1 commit into
masterfrom
docs/readme-architecture-update

Conversation

@devspexx

@devspexx devspexx commented Apr 5, 2026

Copy link
Copy Markdown
Owner

Revise README to align with current ConfigurationAPI design.

  • Remove outdated diff-based features and examples
  • Document GlobalConfigWatcher as single source of truth
  • Update usage examples to match current API (ConfigManager + watcher delegation)
  • Clarify event model (ConfigReloadedEvent with checksums and timing)
  • Improve structure, clarity, and consistency across sections

README now accurately reflects the simplified, atomic, watcher-driven architecture.

Revise README to align with current ConfigurationAPI design.

- Remove outdated diff-based features and examples
- Document GlobalConfigWatcher as single source of truth
- Update usage examples to match current API (ConfigManager + watcher delegation)
- Clarify event model (ConfigReloadedEvent with checksums and timing)
- Improve structure, clarity, and consistency across sections

README now accurately reflects the simplified, atomic, watcher-driven architecture.
@devspexx devspexx merged commit fe71abe into master Apr 5, 2026
@devspexx devspexx deleted the docs/readme-architecture-update branch April 5, 2026 08:52
@devspexx devspexx added the Enhancement An improvement to existing functionality without changing its core behavior. label Apr 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Enhancement An improvement to existing functionality without changing its core behavior.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant