Merge pull request #2948 from input-output-hk/chore/ddw-1069-update-readme-to-include-linking-steps

Author: danielmain

.gitignore

@@ -124,6 +124,8 @@ Debug
 /cardano-cli
 /cardano-wallet
 .vscode
+.yalc
+yalc.lock
 
 # Typescript
 *.scss.d.ts

CHANGELOG.md

@@ -12,6 +12,7 @@
 
 ### Chores
 
+- Added steps on how to link with `react-polymorph` and other external UI libraries ([PR 2948](https://github.com/input-output-hk/daedalus/pull/2948))
 - Published selfnode installers for all 3 platforms ([PR 2971](https://github.com/input-output-hk/daedalus/pull/2971))
 
 ## 4.10.0
@@ -99,12 +100,12 @@
 
 ### Fixes
 
-- Improved error handling for incorrect passphrase and incorrect hardware wallet error ([PR 2860](https://github.com/input-output-hk/daedalus/pull/2860)) 
+- Improved error handling for incorrect passphrase and incorrect hardware wallet error ([PR 2860](https://github.com/input-output-hk/daedalus/pull/2860))
 - Fixed rewards CSV export issues ([PR 2885](https://github.com/input-output-hk/daedalus/pull/2885))
 - Fixed behaviour of wallet settings option of the app menu ([PR 2838](https://github.com/input-output-hk/daedalus/pull/2838))
 - Fixed styling of ITN rewards feature ([PR 2861](https://github.com/input-output-hk/daedalus/pull/2861))
 - Fixed available disk space takes a long time to show ([PR 2849](https://github.com/input-output-hk/daedalus/pull/2849))
-  
+
 ### Chores
 
 - Migrated codebase from javascript to typescript ([PR 2843](https://github.com/input-output-hk/daedalus/pull/2843))

README.md

@@ -207,6 +207,26 @@ You can debug the main process by following one of these approaches:
 
 The inspector runs on port 9229
 
+### Linking with UI Libraries (e.g. React Polymorph)
+
+You can link libraries with Daedalus using one of the following steps:
+
+#### 1) Using `yalc`
+
+1) Install `yalc` globally using `yarn global add yalc`.
+2) Run `yalc publish` from the library's root directory that you want to link with Daedalus.
+3) Switch to Daedalus and run `yalc add <package-name>` or preferably `yalc link <package-name>`.
+4) You should be able to start Daedalus and see the changes you are making locally in the library.
+5) To make sure your changes are reflected as you update code in the library, use `yalc push`.
+
+#### 2) Using `yarn link`
+
+1) From the Daedalus root directory, go to `node_modules/react` and `yarn link`.
+2) Navigate to the `react-dom` package in the same directory and run `yarn link` again.
+3) Go to the library's root directory and run `yarn link`, `yarn link react` and `yarn link react-dom`.
+4) Go back to the Daedalus root directory and run `yarn link <package-name>`.
+5) Finally, run `yarn build:watch` from the library's root directory.
+
 ## Testing
 
 You can find more details regarding tests setup within