docs(readme): drop Project Structure tree, add Sponsor section#292
Merged
docs(readme): drop Project Structure tree, add Sponsor section#292
Conversation
The Project Structure tree was duplicating information that docs/architecture.md already covers in better detail (and updates faster). Removing it from the README keeps the marketing-facing README scoped to "what is this and how do I install it" and points contributors at the proper map. In its place, a short Sponsor section pointing at https://github.com/sponsors/iamtoruk so users who find the tool useful know where to support development.
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.
Two README changes:
Remove the Project Structure tree. It duplicated info that lives more accurately and stays more current in `docs/architecture.md` (added in docs: contributor guide, architecture map, and per-provider docs #284). Anyone wanting the codebase map gets a richer one there.
Add a short Sponsor section pointing at https://github.com/sponsors/iamtoruk for users who find CodeBurn useful and want to support development.
No code changes, no test changes. README only.
```
README.md | 45 ++++++---------------------------------------
1 file changed, 6 insertions(+), 39 deletions(-)
```