Skip to content

Commit 10b950d

Browse files
Update readme to highlight alternative content generators (#542)
1 parent 1651a02 commit 10b950d

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -72,23 +72,25 @@ based on a widget catalog from the developers' project.
7272
- **Basic Layout:** LLM-driven basic layout generation.
7373
- **Any Model:** Integrate with any LLM that can generate structured JSON output.
7474

75-
## Some things we're thinking about
75+
## Connecting to an AI Agent
7676

77-
- **Genkit Integration:** Integration with Genkit.
78-
- **ADK Plugin:** turnkey integration with ADK.
79-
- **Expanded LLM Framework Support:** Official support for additional LLM frameworks.
80-
- **Streaming UI:** Support for progressively rendering UI components as they stream from the LLM.
81-
- **Full-Screen Composition:** Enable LLM-driven composition and navigation of entire app screens.
82-
- **A2A Agent Support:** Support for A2A agent interactions.
83-
- **Dart Bytecode:** Future support for Dart Bytecode for even greater dynamism and flexibility.
77+
The `genui` framework uses a `ContentGenerator` to communicate with a generative AI model,
78+
allowing `genui` to be backend agnostic. You can choose the implementation that best fits
79+
your needs, whether it's `FirebaseAiContentGenerator` for production apps,
80+
`GoogleGenerativeAiContentGenerator` for rapid prototyping, or `A2uiContentGenerator` for
81+
custom agent servers.
82+
83+
See the package table below for more details on each.
8484

8585
## Packages
8686

87-
| Package | Description |
88-
| ---------------------------------------------------------------- | ----------------------------------------------------------------------------- |
89-
| [genui](packages/genui/) | A framework to employ Generative UI. |
90-
| [genui_firebase_ai](packages/genui_firebase_ai/) | Firebase AI integration for genui. |
91-
| [json_schema_builder](packages/json_schema_builder/) | A fully featured Dart JSON Schema package with validation. |
87+
| Package | Description |
88+
| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
89+
| [genui](packages/genui/) | The core framework to employ Generative UI. |
90+
| [genui_firebase_ai](packages/genui_firebase_ai/) | Provides **`FirebaseAiContentGenerator`** to connect to Gemini via Firebase AI Logic. This is the recommended approach for production apps based on client-side agents. |
91+
| [genui_google_generative_ai](packages/genui_google_generative_ai/) | Provides **`GoogleGenerativeAiContentGenerator`** for connecting to the Google Generative AI API with only an API key. Ideal for getting started quickly. |
92+
| [genui_a2ui](packages/genui_a2ui/) | Provides **`A2uiContentGenerator`** for connecting to any server that implements the [A2UI protocol](https://a2ui.org). Use this for integrating with custom agent backends. |
93+
| [json_schema_builder](packages/json_schema_builder/) | A fully featured Dart JSON Schema package with validation, used by the core framework to define widget data structures. |
9294

9395
## Usage
9496

@@ -98,6 +100,16 @@ See [packages/genui/USAGE.md](packages/genui/USAGE.md).
98100

99101
This repo requires Flutter version >=3.35.7.
100102

103+
## Some things we're thinking about
104+
105+
- **Genkit Integration:** Integration with Genkit.
106+
- **ADK Plugin:** turnkey integration with ADK.
107+
- **Expanded LLM Framework Support:** Official support for additional LLM frameworks.
108+
- **Streaming UI:** Support for progressively rendering UI components as they stream from the LLM.
109+
- **Full-Screen Composition:** Enable LLM-driven composition and navigation of entire app screens.
110+
- **A2A Agent Support:** Support for A2A agent interactions.
111+
- **Dart Bytecode:** Future support for Dart Bytecode for even greater dynamism and flexibility.
112+
101113
## Contribute
102114

103115
See [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)