From 5bca47b24c03b1a1bfef7bc2c69874e959b1b2dd Mon Sep 17 00:00:00 2001 From: Joe Clark Date: Fri, 21 Jun 2024 14:26:21 +0100 Subject: [PATCH] docs --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 152dc6b9d10..56447e109fa 100644 --- a/README.md +++ b/README.md @@ -76,12 +76,23 @@ library". yarn start:dev ``` -Or, if the server is running: +This will first generate adaptors from your monorepo, then launch the server. + +You can trigger a rebuild with: ``` yarn generate-adaptors -m ``` +Where `-m` means "build from the monorepo. + +To automatically rebuild whenever docs.json changes, run `generate-adaptors` +with watch mode: + +``` +yarn generate-adaptors -w +``` + Ensure that the OPENFN_ADAPTORS_REPO env var is set and points to the local monorepo.