@tedi-design-system/react 14.4.0-rc.1 → 14.4.0-rc.2
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 +30 -14
- package/bundle-stats.html +1 -1
- package/index.css +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,40 +1,56 @@
|
|
|
1
1
|
# TEDI Design System for React
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://github.com/semantic-release/semantic-release)
|
|
5
|
-
|
|
6
|
-
`@tedi-design-system/react` is a library of React components implementing the TEDI Design System.
|
|
3
|
+
`@tedi-design-system/react` is a library of React components implementing the TEDI Design System.
|
|
7
4
|
It provides reusable, accessible, and consistent UI components to streamline building React applications.
|
|
8
5
|
|
|
9
|
-
Usage instructions and detailed documentation
|
|
6
|
+
Usage instructions and detailed documentation for using the components in your application are available in [Storybook](https://storybook.tedi.ee/react/main/?path=/docs/documentation-get-started--get-started).
|
|
7
|
+
|
|
8
|
+
[](https://codecov.io/gh/TEHIK-EE/tedi-design-system/graph/badge.svg?token=NKNNJSG19D)
|
|
9
|
+
[](https://github.com/semantic-release/semantic-release)
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Getting Started (Using the package)
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
If you are installing `@tedi-design-system/react` in your own project, follow the
|
|
16
|
+
[Get Started guide in Storybook](https://storybook.tedi.ee/react/main/?path=/docs/documentation-get-started--get-started)
|
|
16
17
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
The Storybook documentation covers:
|
|
19
|
+
|
|
20
|
+
- installation instructions
|
|
21
|
+
- required styles and providers
|
|
22
|
+
- component usage examples
|
|
23
|
+
- accessibility notes
|
|
24
|
+
- component APIs
|
|
20
25
|
|
|
21
26
|
---
|
|
22
27
|
|
|
23
|
-
## Development Guide
|
|
28
|
+
## Repository Development Guide (Contributors)
|
|
24
29
|
|
|
25
|
-
|
|
30
|
+
The following instructions apply only if you are working on this repository itself
|
|
31
|
+
(e.g. developing, fixing, or adding components).
|
|
26
32
|
|
|
27
|
-
|
|
33
|
+
### Install dependencies
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
npm install
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Running Storybook locally
|
|
40
|
+
|
|
41
|
+
To view and develop components in isolation, start Storybook:
|
|
28
42
|
|
|
29
43
|
```
|
|
30
44
|
npm run start
|
|
31
45
|
```
|
|
32
46
|
|
|
47
|
+
This will launch a local Storybook instance for component development.
|
|
48
|
+
|
|
33
49
|
---
|
|
34
50
|
|
|
35
51
|
## Contributing
|
|
36
52
|
|
|
37
|
-
Check the [wiki](https://github.com/TEDI-Design-System/general) for component guidelines and coding standards.
|
|
53
|
+
Check the [wiki](https://github.com/TEDI-Design-System/general/wiki) for component guidelines and coding standards.
|
|
38
54
|
Report issues or contribute via [GitHub Issues](https://github.com/TEDI-Design-System/react/issues).
|
|
39
55
|
|
|
40
56
|
---
|