docs: expand README - #4
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request restructures the README.md to provide a clearer overview of the project, including a repository map and dedicated sections for the 'Degen edition' and 'Ethical ad filter'. The review feedback identifies missing documentation and license files referenced in the text, and suggests refining header titles and list formatting for better consistency and a more public-facing tone.
| | [`docs/ethical-ad-filter/`](docs/ethical-ad-filter/) | **Ethical ad filter** specs: taxonomy, ADR, evidence bundles, SusLink integration notes | | ||
| | [`schemas/`](schemas/) | JSON Schemas for policy artifacts and evidence bundles | | ||
| | [`examples/`](examples/) | Example policy JSON | | ||
| | [`planning/roadmap.md`](planning/roadmap.md) | High-level roadmap | | ||
| | [`docs/setup.md`](docs/setup.md) | Setup notes (to be expanded) | |
There was a problem hiding this comment.
The directory docs/ and its contents (ethical-ad-filter/, setup.md) are referenced in the repository map (lines 14, 18, 20, 80) but do not appear to exist in the current branch based on the provided file structure. Please ensure these files are added to the repository or update the links if they have been moved or renamed to avoid broken links in the documentation.
| ## Degen edition (positioning) | ||
|
|
||
| Currently in active development. The app uses local state management - data persists during your session but isn't saved permanently yet. | ||
| *Outsmart the urge. Protect the stack. Learn your patterns.* | ||
|
|
||
| A **behavioral awareness** angle for people who gamble: same philosophy as Mischief Manager (awareness, optional guardrails, user control)—applied to **avoiding rinse cycles** and tilt without telling people they “can’t play.” | ||
|
|
||
| **Highlights** | ||
|
|
||
| Degen Edition | ||
| Outsmart the Urge. Protect the Stack. Learn Your Patterns. | ||
| - Max bet awareness and soft, reflective warnings | ||
| - Optional auto-vault of a % of winnings (visible, user-controlled) | ||
| - Session tagging, tilt and “rinse” history, game-type trends | ||
| - Budget guardrails as **charts and reflection**, not locks | ||
| - Post-rinse optional prompts and trends—**opt-in** |
There was a problem hiding this comment.
The header 'Degen edition (positioning)' contains a meta-label '(positioning)' which might be more appropriate for internal design notes than a public-facing README. Additionally, the highlights in this section are formatted differently than the 'Core features' section. Consider removing the meta-label and using a consistent bold-prefix style for the highlights to improve readability and maintainability.
| ## Degen edition (positioning) | |
| Currently in active development. The app uses local state management - data persists during your session but isn't saved permanently yet. | |
| *Outsmart the urge. Protect the stack. Learn your patterns.* | |
| A **behavioral awareness** angle for people who gamble: same philosophy as Mischief Manager (awareness, optional guardrails, user control)—applied to **avoiding rinse cycles** and tilt without telling people they “can’t play.” | |
| **Highlights** | |
| Degen Edition | |
| Outsmart the Urge. Protect the Stack. Learn Your Patterns. | |
| - Max bet awareness and soft, reflective warnings | |
| - Optional auto-vault of a % of winnings (visible, user-controlled) | |
| - Session tagging, tilt and “rinse” history, game-type trends | |
| - Budget guardrails as **charts and reflection**, not locks | |
| - Post-rinse optional prompts and trends—**opt-in** | |
| ## Degen edition | |
| *Outsmart the urge. Protect the stack. Learn your patterns.* | |
| A **behavioral awareness** angle for people who gamble: same philosophy as Mischief Manager (awareness, optional guardrails, user control)—applied to **avoiding rinse cycles** and tilt without telling people they “can’t play.” | |
| **Highlights** | |
| - **Max bet awareness** — soft, reflective warnings when exceeding thresholds | |
| - **Auto-vault winnings** — optional earmarking of a % of profits (user-controlled) | |
| - **Session tagging** — track tilt, “rinse” history, and game-type trends | |
| - **Budget guardrails** — visual charts and reflection, not hard locks | |
| - **Post-rinse prompts** — optional prompts and trends (opt-in) |
|
|
||
| --- | ||
|
|
||
| ## Ethical ad filter (product architecture) |
There was a problem hiding this comment.
Similar to the 'Degen edition' section, the label '(product architecture)' in the header feels like an internal classification. Removing it would make the header cleaner for general readers.
| ## Ethical ad filter (product architecture) | |
| ## Ethical ad filter |
| This isn’t about telling people they can't play. It’s about helping them understand how they play — building awareness, strengthening self-trust, and turning impulsive habits into intentional ones. | ||
| ## License | ||
|
|
||
| See [`LICENSE`](LICENSE). |
There was a problem hiding this comment.
The LICENSE file is referenced here and in the App.tsx header, but it is missing from the repository root. Please add the license file to ensure the project's licensing terms are clearly accessible.
1 participant
Restructures root README: repo map (reactSetup, ethical-ad-filter docs, schemas), cleaned Degen edition section, GitHub org link, license pointer.
Made with Cursor