diff --git a/README.md b/README.md index 2cdf8131..46bce073 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,32 @@ For development: ```bash git clone https://github.com/Exabyte-io/cove.js.git +cd cove.js +npm install +npm run transpile ``` +How to link cove.js to host app: +```bash +rm -rf {PATH}/exabyte-stack/web-app/src/application/node_modules/@exabyte-io/cove.js/dist +ln -s "$(pwd)/dist/" /{ABSOLUTE_PATH}/exabyte-stack/web-app/src/application/node_modules/@exabyte-io/cove.js +restart host app (web-app, wave etc.) +``` + +another approach is to access cove from repo + +```bash +push your branch +replace cove.js version with url in package.json +"@exabyte-io/cove.js": "https://github.com/Exabyte-io/cove.js#cc48da9652840eb0f7d8854e02cb690484e6fab1", +``` +make sure to install appropriate versions of peerDependencies from cove.js to host app + +DO NOT use `npm link` as it leads to having multiple react libs in app. +See links: +https://github.com/facebook/react/issues/13991 +https://legacy.reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react + ### Typescript Typescript and all necessary type dependencies must be present in dependency section of package.json in order