@gusto/embedded-react-sdk 0.0.1 → 0.0.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 +15 -0
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -11,3 +11,18 @@ To run:
|
|
|
11
11
|
```bash
|
|
12
12
|
npm run dev
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Local development
|
|
16
|
+
|
|
17
|
+
- Follow setup instructions in the readme for [GWS Flows](https://github.com/Gusto/gws-flows)
|
|
18
|
+
- In this project folder, run `yarn link`
|
|
19
|
+
- In GWS-Flows project folder, run `yarn link "@gusto/embedded-react-sdk"`
|
|
20
|
+
|
|
21
|
+
Now your local changes appear in GWS Flows.
|
|
22
|
+
|
|
23
|
+
To see the SDK running in GWS Flows, visit it [locally](http://localhost:7777/demos?react_sdk=true) and choose `React SDK` under `Select a Type` and click `Create Demo`
|
|
24
|
+
|
|
25
|
+
## Cutting a new release
|
|
26
|
+
|
|
27
|
+
- Get your changes and a version increase in the package.json `version` field into the main branch however you want
|
|
28
|
+
- Run the `Publish to NPM` GitHub action [here](https://github.com/Gusto/embedded-react-sdk/actions/workflows/publish.yaml) by clicking `Run workflow`
|