readme(tracker): build-readme for js packages

This commit is contained in:
Alex Kaminskii 2022-05-06 00:07:07 +02:00
parent bd07d42084
commit 2d96705930

31
tracker/README.md Normal file
View file

@ -0,0 +1,31 @@
## Local build
In order to build locally any of the javascript packages located under this directory, go to the corresponding folder first:
```sh
cd tracker # or any tracker-* plugin
```
Then run
```sh
yarn
yarn build
```
OR
```sh
npm i
npm run build
```
You can then use it as a local javascript package by executing the folowing line under your local project location:
```sh
yarn add file:../path/to/openreplay/monorepo/tracker/tracker
````
OR
```sh
npm install --save ../path/to/openreplay/monorepo/tracker/tracker
```