Skip to content

docs: update readme with screenshot#3

Merged
sirily11 merged 1 commit intomainfrom
readme
Apr 3, 2026
Merged

docs: update readme with screenshot#3
sirily11 merged 1 commit intomainfrom
readme

Conversation

@sirily11
Copy link
Copy Markdown
Contributor

@sirily11 sirily11 commented Apr 3, 2026

No description provided.

Copilot AI review requested due to automatic review settings April 3, 2026 18:39
@sirily11 sirily11 enabled auto-merge (squash) April 3, 2026 18:39
@autopilot-project-manager autopilot-project-manager bot added the documentation Improvements or additions to documentation label Apr 3, 2026
@sirily11 sirily11 merged commit 735ade8 into main Apr 3, 2026
5 checks passed
@sirily11 sirily11 deleted the readme branch April 3, 2026 18:40
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project README to better showcase the example app by adding a download hint and an embedded screenshot, helping new users quickly understand and try the on-demand UI generation flow.

Changes:

  • Expanded the “Inspired by …” line with guidance to download and try the example app.
  • Added a screenshot image to the README.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

A SwiftUI **Generative UI** framework. AI generates JSON specs, your app renders them as native SwiftUI views.

Inspired by [json-render](https://github.com/vercel-labs/json-render) from Vercel Labs.
Inspired by [json-render](https://github.com/vercel-labs/json-render) from Vercel Labs. You can go to `release` to download the example app to try the on demand UI generation by yourself.
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README says to go to release, but on GitHub the tab is typically “Releases” (plural). Consider linking directly to the repository releases page (e.g., .../releases) and rephrasing the sentence for clarity (also “on-demand” is usually hyphenated).

Suggested change
Inspired by [json-render](https://github.com/vercel-labs/json-render) from Vercel Labs. You can go to `release` to download the example app to try the on demand UI generation by yourself.
Inspired by [json-render](https://github.com/vercel-labs/json-render) from Vercel Labs. You can download the example app from the repository’s [Releases](https://github.com/anthropics/json-render-swift/releases) page to try the on-demand UI generation yourself.

Copilot uses AI. Check for mistakes.
Inspired by [json-render](https://github.com/vercel-labs/json-render) from Vercel Labs.
Inspired by [json-render](https://github.com/vercel-labs/json-render) from Vercel Labs. You can go to `release` to download the example app to try the on demand UI generation by yourself.

![screenshot](./screenshots/app-screen1.png)
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For accessibility, the image alt text screenshot is very generic. Consider using a more descriptive alt text that conveys what the screenshot shows (e.g., the example app UI / generated screen).

Suggested change
![screenshot](./screenshots/app-screen1.png)
![JSONRenderSwift example app UI showing a generated SwiftUI screen](./screenshots/app-screen1.png)

Copilot uses AI. Check for mistakes.
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