Skip to content

Commit 8bf09a9

Browse files
committed
Update readme of react-wrapper to be more helpful
1 parent 5fefece commit 8bf09a9

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

packages/react-library/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# @kit-data-manager/react-pid-component
22

3-
React wrapper for @kit-data-manager/pid-component
3+
React wrapper for [@kit-data-manager/pid-component](https://github.com/kit-data-manager/pid-component)
4+
5+
## Usage
6+
7+
Refer to the documentation of [@kit-data-manager/pid-component](https://github.com/kit-data-manager/pid-component).
8+
9+
> **Important:** When using the React wrapper you have to use camelCase. Component names must be capitalized in React, see below.
10+
11+
### Example
12+
13+
```typescript jsx
14+
import { PidComponent } from "@kit-data-manager/react-pid-component"
15+
16+
function MyComponent() {
17+
return <PidComponent value={"something"} emphasizeContent={false} />
18+
}
19+
```

0 commit comments

Comments
 (0)