@equinor/echo-framework 0.14.1-beta-4 → 0.14.1-beta-6

package/README.md

@@ -17,13 +17,29 @@ How to develop EchoFramework in the new, monorepo structure?
 -   Do not run npm install in `libs/echo-framework`
     -   Do that in the root folder: NX uses every dependency from the root for all libraries
 -   Do not add anything to `package.json` found in `echo-framework` library
-    -   For `echo-framework` NX generates the `package.json` on build partly based on the local `package.json`
+    -   For `echo-framework` NX generates the `package.json` on build partly based on the root `package.json`
     -   All dependencies used during development will be taken from the root folder, based on the `package.json` found there
 -   Note: some initial peerDependencies have been added to the base `echo-framework` package.json
     -   That's because instead of a fixed version we would like to define a version range.
     -   In case of react: `"react": ">= 17.0.2"`
     -   When `echo-framework`'s package.json is generated, these pre-defined versions will be used
 
+### Adding new dependency to EchoFramework
+
+Only add any new dependency to framework if it's really necessary.
+
+As mentioned above:
+
+-   Do not add anything to `package.json` found in `echo-framework` library
+    -   For `echo-framework` NX generates the `package.json` on build partly based on the root `package.json`
+
+Steps
+
+1.  Setup - Install the new dependency on the root folder package.json
+2.  Coding - Use it in echo-framework code as normal (NX will generate the dependency as peerDep in the build package.json)
+3.  Adjusting NX rollup build - In `libs/echo-framework` add the new package as `external` into the `project.json`
+4.  Updating EchoClient - in `non-monorepo-libs/echo-client` install the same package. As EchoClient is the dev tool for other teams (they're not developing in echopediaWeb context), it needs to provide the peerDependencies for echoFramework to work.
+
 ## How to make new release of echoFramework?
 
 -   Bump version in the package.json for `echoFramework` in libs/echo-framework in your PR