Skip to content

docs: simplify README install and modernize image example#6390

Draft
Alek99 wants to merge 2 commits intomainfrom
docs/readme-cleanup
Draft

docs: simplify README install and modernize image example#6390
Alek99 wants to merge 2 commits intomainfrom
docs/readme-cleanup

Conversation

@Alek99
Copy link
Copy Markdown
Member

@Alek99 Alek99 commented Apr 27, 2026

Summary

  • Collapse the README install/quickstart into a single uv-based block (mkdir / cd / uv init / uv add reflex / uv run reflex init / uv run reflex run).
  • Move the All Thanks To Our Contributors section from README.md to the bottom of CONTRIBUTING.md.
  • Remove the standalone License section from README.md (license info still lives in LICENSE).
  • Update the image generation example to use gpt-image-1.5 and render the base64 data URL returned by the Images API.

Test plan

  • git diff --check
  • README renders correctly on GitHub
  • mkdir my_app_name && cd my_app_name && uv init && uv add reflex && uv run reflex init && uv run reflex run works on a clean dir
  • CONTRIBUTING.md renders the contributors graphic at the bottom
  • Updated example code runs and renders the generated image via data URL

Generated with Claude Code

- Collapse the install/quickstart section into a single uv-based block
- Move "All Thanks To Our Contributors" from README to CONTRIBUTING.md
- Drop the standalone License section from README
- Update DALL-E example to gpt-image-2-2026-04-21 (b64 data URL)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 27, 2026

Merging this PR will not alter performance

✅ 9 untouched benchmarks


Comparing docs/readme-cleanup (163f027) with main (7a7a4d3)

Open in CodSpeed

@adhami3310 adhami3310 added the documentation Improvements or additions to documentation label Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants