diff --git a/container-build/cerc-builder-js/README.md b/container-build/cerc-builder-js/README.md index aa644612..ea09f21e 100644 --- a/container-build/cerc-builder-js/README.md +++ b/container-build/cerc-builder-js/README.md @@ -1,11 +1,16 @@ -## Building JS/TS Packages +## JS/TS Package Builder + +This container is designed to be used as a simple "build runner" environment for building and publishing JS/TS projects +using `yarn`. + +### Running a build As a temporary measure while the necessary functionality is being added to Stack Orchestrator, it is possible to build packages manually by invoking `docker run` , for example as follows: ``` -docker run -it --add-host host.docker.internal:host-gateway \ +$ docker run -it --add-host host.docker.internal:host-gateway \ -v ${HOME}/cerc/laconic-sdk:/workspace cerc/builder-js \ sh -c 'cd /workspace && NPM_AUTH_TOKEN=6613572a28ebebaee20ccd90064251fa8c2b94f6 \ /build-npm-package.sh http://host.docker.internal:3000/api/packages/cerc-io/npm/ 1.2.3-test' -``` \ No newline at end of file +```