From d369728d60bb8330200e187ec15cfc64a53684e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emanuel=20Tesa=C5=99?= Date: Tue, 26 Sep 2023 08:32:03 +0200 Subject: [PATCH] Fix README.md --- README.md | 9 +++++++++ packages/common/README.md | 8 ++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index 710f0d5e..12cfd39b 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,12 @@ The repo uses `pnpm` workspaces. To install the dependencies: ```sh pnpm install ``` + +and to build the packages: + +```sh +pnpm run build +``` + +Note, that everytime you make a change to a workspace that is used as a dependency of another, you need to rebuild the +changed package (otherwise you might get weird JS/TS errors). diff --git a/packages/common/README.md b/packages/common/README.md index d44dcb59..b01cd831 100644 --- a/packages/common/README.md +++ b/packages/common/README.md @@ -1,3 +1,11 @@ # common Utilities commonly used by other packages. + +## Getting started + +Use: + +```sh +pnpm run build +```