@openfin/ui-library 0.9.0-alpha.1674510697 → 0.9.0
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
CHANGED
|
@@ -28,15 +28,11 @@ This is an opinionated React component library, built on top of [styled-componen
|
|
|
28
28
|
```bash
|
|
29
29
|
# Install the latest version
|
|
30
30
|
$ yarn add @openfin/ui-library styled-components
|
|
31
|
-
# For npm
|
|
32
|
-
$ npm i @openfin/ui-library styled-components
|
|
33
31
|
```
|
|
34
32
|
|
|
35
33
|
```bash
|
|
36
34
|
# Install a specific version
|
|
37
|
-
$ yarn add @openfin/ui-library@
|
|
38
|
-
# For npm
|
|
39
|
-
$ npm i @openfin/ui-library@0.8.0
|
|
35
|
+
$ yarn add @openfin/ui-library@v1.0.1
|
|
40
36
|
```
|
|
41
37
|
|
|
42
38
|
## Usage
|
|
@@ -122,7 +118,7 @@ Great for exploring and experimenting with UI Library components. It's also used
|
|
|
122
118
|
|
|
123
119
|
```bash
|
|
124
120
|
# Run it locally
|
|
125
|
-
$
|
|
121
|
+
$ yarn storybook
|
|
126
122
|
```
|
|
127
123
|
|
|
128
124
|
### Codesandbox.io
|
|
@@ -156,11 +152,11 @@ This links your local copy of UI Library to your app using symlinks and `package
|
|
|
156
152
|
|
|
157
153
|
Once you're setup, subsequent changes in UI Library can be propagated across easily.
|
|
158
154
|
|
|
159
|
-
After making changes in `ui-library`, run `
|
|
155
|
+
After making changes in `ui-library`, run `yarn build && yalc push`. This will apply a version bump to the local yalc package respository. It will also update the package in your app directory, but you will most likely need to restart any development servers to see the changes.
|
|
160
156
|
|
|
161
157
|
```sh
|
|
162
158
|
# push updates from ui-library side to your app
|
|
163
|
-
$
|
|
159
|
+
$ yarn build && yalc push
|
|
164
160
|
```
|
|
165
161
|
|
|
166
162
|
#### Known Issues
|
|
@@ -184,7 +180,7 @@ Extending base config used by `Storybook` to quiet some extraneous warnings.
|
|
|
184
180
|
## Testing
|
|
185
181
|
|
|
186
182
|
```sh
|
|
187
|
-
|
|
183
|
+
yarn test
|
|
188
184
|
```
|
|
189
185
|
|
|
190
186
|
## Versioning & Releasing
|