@solace-health/ui 0.1.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 ADDED
@@ -0,0 +1,28 @@
1
+ <p align="center">
2
+ <a href="https://solace.health" target="_blank" align="center">
3
+ <img src="https://app.solace.health/static/icons/apple-touch-icon.png" width="200">
4
+ </a>
5
+ <br />
6
+ </p>
7
+
8
+ # Official React Solace Component Library ![](https://img.shields.io/badge/React-Typescript-blue)![](https://img.shields.io/badge/Version-1.0.0-green)
9
+
10
+ ## Changelogs
11
+ Checkout the changelogs per release [here](https://github.com/Solace-Health/solace-health-ui/releases)!
12
+
13
+ ## Getting Started
14
+
15
+ Install the `@solacehealth/ui` package
16
+
17
+ ```sh
18
+ npm install @solacehealth/ui
19
+ ```
20
+
21
+ ## For Development
22
+ 1. Run `npm i`
23
+ 2. Run `npm run storybook` or `npm run dev` is you only need to run in watch mode
24
+
25
+ ## Deploy to NPM
26
+ Simply cut a new [release](https://github.com/Solace-Health/solace-health-ui/releases) in github with an appropriate semantic version. There is a github action that will fire when it detects a new cut tag. From there it will build and deploy using the tag from github and mark it as latest. Once that is complete, the action will update the version in package.json. No need for any manual updates on the code side.
27
+
28
+ We use release drafter to scaffold the upcoming releases. You rarely will need to draft a new release manually.