From 2d96705930ab32e1b8cb29b01e40452a4d3584e9 Mon Sep 17 00:00:00 2001 From: Alex Kaminskii Date: Fri, 6 May 2022 00:07:07 +0200 Subject: [PATCH] readme(tracker): build-readme for js packages --- tracker/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 tracker/README.md diff --git a/tracker/README.md b/tracker/README.md new file mode 100644 index 000000000..f283ee3a8 --- /dev/null +++ b/tracker/README.md @@ -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 +``` +