docs: updated README.md with graphics and sample example #296
Conversation
![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 improves the README.md by adding visuals and examples, which is a great way to showcase the project's capabilities. I've made a few suggestions to correct some minor grammatical errors and improve the readability of the new text. Overall, these are valuable additions to the documentation.
via Gemini Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
via Gemini Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
via Gemini Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
via Gemini Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
misc/travel_app_genui_example.png
Outdated
There was a problem hiding this comment.
Nit: Could you update the blue text to 'The LLM generated this interactive UI by composing widgets in the app's "Catalog"'?
Overall this graph is awesome!
README.md
Outdated
| @@ -81,6 +81,23 @@ Widget build(BuildContext context) { | |||
| } | |||
| ``` | |||
|
|
|||
| ## Look & Feel | |||
| Here's how it works in practice, but please be advised it's labelled as "Highly Experimental". | |||
There was a problem hiding this comment.
I think we don't need to state this again because it's written elsewhere.
README.md
Outdated
| *The GIF above shows how GenUI enables dynamic, interactive UI generation — instead of text descriptions or code from a traditional AI coding agent.* | ||
|
|
||
| ### Core Difference | ||
| This UI is not generated in the form of code; rather, it's generated at runtime based on a widget catalog from the developers' project (application catalog) combined with the genui catalog (standard catalog). |
There was a problem hiding this comment.
Can this just be:
"This UI is not generated in the form of code; rather, it's generated at runtime based on a widget catalog from the developers' project"
We're not sure yet whether we should focus on providing a standard catalog or let developers choose all the widgets, so don't want to emphasize this yet.
README.md
Outdated
|
|
||
| <img src="misc/travel_app_genui_example.png" alt="GenUI Features Breakdown" height="600"> | ||
|
|
||
| *This screenshot highlights the core implementation of traditional LLM-based UI vs. GenUI-based UI.* |
There was a problem hiding this comment.
I think we can remove this explanatory text
…thub.com/mhmzdev/genui into docs/added-graphics-for-visuals-of-genui
Description
Pre-launch Checklist
///).Results
Added a .gif and .png graphics: