@fellesdatakatalog/ui 1.0.8 → 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
Library of React components for FDK frontend apps.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## How to use
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
yarn add @fellesdatakatalog/ui
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```scss
|
|
12
|
+
// In your app stylesheet
|
|
13
|
+
@import '@fellesdatakatalog/ui/dist/styles.css';
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
import { HelpText } from '@fellesdatakatalog/ui';
|
|
18
|
+
|
|
19
|
+
<HelpText>This is my helptext</HelpText>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Otherwise run this repo locally and have a look at the embedded Storybook for additional component documentation and usage examples.
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
yarn storybook
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Contributing
|
|
6
29
|
|
|
7
30
|
### Prerequisites
|
|
8
31
|
|