@kroo-web/design-system 1.1.73 → 1.1.75

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.
Files changed (7) hide show
  1. package/README.MD +11 -3
  2. package/dist/cjs/index.js +15 -10
  3. package/dist/cjs/src/components/Modal/index.d.ts +3 -1
  4. package/dist/esm/index.js +16 -11
  5. package/dist/esm/src/components/Modal/index.d.ts +3 -1
  6. package/dist/types.d.ts +3 -1
  7. package/package.json +4 -1
package/README.MD CHANGED
@@ -54,16 +54,24 @@ If you would like to test the design system without deploying the package you ca
54
54
  npm link
55
55
  ```
56
56
 
57
- then in a project where the design system is being used run the following command.
57
+ in the design system repo you will also have to run to use the react version from the repo where the design system is being used
58
58
 
59
- This will overwrite the package with the local version of the package.
59
+ ```
60
+ npm link ../myproject/node_modules/react
61
+ npm link ../myproject/node_modules/react-dom
62
+ ```
60
63
 
61
- <i>**Note**: Does not show up in the package.json it just replaces the node_modules package. this is so an unreleased version of the package cannot be deployed to prod (so after development make sure you npm install again to overwrite the local version of the package).</i>
64
+ then in a project where the design system is being used run the following command.
62
65
 
63
66
  ```bash
64
67
  npm link @kroo-web/design-system
65
68
  ```
66
69
 
70
+ This will overwrite the package with the local version of the package and will update when rebuilt.
71
+
72
+ <i>**Note**: Does not show up in the package.json it just replaces the node_modules package. this is so an unreleased version of the package cannot be deployed to prod (so after development make sure you npm install again to overwrite the local version of the package).</i>
73
+
74
+
67
75
  ## Next Steps
68
76
 
69
77
  This sways more on the side of component library rather than a design system due to the lack of tokens and living documentation. However, next steps would be to create a seperate package called @kroo-web/tokens allowing us to version the tokens and use them in the design system.