Skip to content

Commit 49bed8e

Browse files
committed
docs: readme improved
1 parent 8537209 commit 49bed8e

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,18 @@ This npm package provides a collection of reusable Patternfly React components t
99

1010
## Provides:
1111

12-
- Patternfly React Components
13-
- OneCardWrapper
14-
- ImageComponent
15-
- TableWrapper
16-
- VideoPlayerWrapper
17-
- SetOfCardsWrapper
18-
12+
* Rendering for [Next Gen UI Dynamic Componets](https://redhat-ux.github.io/next-gen-ui-agent/guide/data_ui_blocks/dynamic_components/) using React components:
13+
- Implemented components: `one-card`, `image`, `table`, `video-player`, `set-of-cards`
14+
- `video-player` supports YouTube video URLs and direct video file URLs
15+
- `set-of-cards` displays multiple OneCard components in an auto-aligned grid layout
1916
* Dynamic Component Renderer
20-
- DynamicComponents
21-
* Supported Components
22-
- `one-card`, `image`, `table`, `video-player`, `set-of-cards`
23-
- `video-player` supports YouTube video URLs and direct video file URLs
24-
- `set-of-cards` displays multiple OneCard components in an auto-aligned grid layout
17+
- `DynamicComponent`
18+
* Patternfly React Components
19+
- `OneCardWrapper`
20+
- `ImageComponent`
21+
- `TableWrapper`
22+
- `VideoPlayerWrapper`
23+
- `SetOfCardsWrapper`
2524

2625
## Installation
2726

@@ -36,6 +35,8 @@ npm install @rhngui/patternfly-react-renderer
3635

3736
## Usage Examples
3837

38+
**Note:** JSON configs used in examples are normally produced by _Next Gen UI Agent_.
39+
3940
### OneCard Component
4041

4142
```jsx
@@ -204,5 +205,5 @@ function App() {
204205
## Links
205206

206207
- [Documentation](https://redhat-ux.github.io/next-gen-ui-agent/guide/renderer/patternfly_npm/)
207-
- [Source Code](https://github.com/RedHat-UX/next-gen-ui-agent/tree/main/libs_js/next_gen_ui_react)
208+
- [Source Code](https://github.com/RedHat-UX/next-gen-ui-react)
208209
- [Contributing](https://redhat-ux.github.io/next-gen-ui-agent/development/contributing/)

0 commit comments

Comments
 (0)