@solace-health/ui 0.10.248 → 0.10.250

package/README.md

@@ -25,6 +25,40 @@ npm install @solace-health/ui
 2. Run `npm run storybook` or `npm run dev` is you only need to run in watch mode
 
 ## Use local package in external application
+### Using `npm link`
+First, make sure the ui library and app you're working on are running the same Node version. If not, the app will select the version that matches, i.e. the one in its node_modules. Simply update .nvmrc in the ui library locally if needed and remember to not commit it unless needed.
+
+In the UI library folder:
+```
+npm link
+```
+
+In the app folder:
+```
+npm link @solace-health/ui
+```
+
+Voila! Next will hot reload changes made in the ui library as long as it is running `npm run dev`.
+
+🚨 **If you are running into issues with dependencies**
+Add a webpack alias if duplicate dependencies are causing issues. [More info](https://blog.maximeheckel.com/posts/duplicate-dependencies-npm-link/)
+```
+const nextConfig = {
+  // the rest of the config
+  webpack: (config) => {
+    const newConfig = {...config};
+
+    newConfig.resolve.alias = {
+      ...(config.resolve.alias || {}),
+      "@emotion/react": path.resolve("./node_modules/@emotion/react"),
+    };
+    return newConfig;
+  },
+}
+```
+
+### Using `yalc`
+This legacy method is not as reliable but previously the only way to link the ui library with the app. If possible, try to use `npm link` first.
 
 Install [yalc](https://github.com/wclr/yalc) globally