From 7014a515d7437113921bd8c15ad79afe46a59d22 Mon Sep 17 00:00:00 2001 From: Alex Bello <77049455+alxbello@users.noreply.github.com> Date: Thu, 23 Apr 2026 11:44:39 -0500 Subject: [PATCH 1/2] docs: add installation instructions for local development Add Installation section to README with git clone and local install steps since the package is not yet published to npm. Co-authored-by: Kiro Agent <244629292+kiro-agent@users.noreply.github.com> --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 8f1d262..8490ee7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,23 @@ A TypeScript framework for defining [Kiro](https://kiro.dev) agentic configurations using CDK-style constructs. Enables composability, reusability, and type safety for AI agent configuration. +## Installation + +> **Note:** This package is not yet published to npm. Install from source: + +```bash +git clone https://github.com/kirodotdev-labs/constructs.git +cd constructs +npm install +npm run build +``` + +Then in your project, add a dependency pointing to the local package: + +```bash +npm install ../constructs/packages/kiro-constructs constructs +``` + ## Quick Start ```typescript From 68ed0e09b21156ba5bd8027a42e048dce2e877f1 Mon Sep 17 00:00:00 2001 From: Alex Bello <77049455+alxbello@users.noreply.github.com> Date: Thu, 23 Apr 2026 11:46:23 -0500 Subject: [PATCH 2/2] docs: use npm link for local installation workflow Switch from fragile relative path install to npm link, which is the idiomatic approach for local package development. Also clarify that constructs is a required peer dependency. Co-authored-by: Kiro Agent <244629292+kiro-agent@users.noreply.github.com> --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8490ee7..f5b265f 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,15 @@ git clone https://github.com/kirodotdev-labs/constructs.git cd constructs npm install npm run build +cd packages/kiro-constructs +npm link ``` -Then in your project, add a dependency pointing to the local package: +Then in your project, link the package and install the required `constructs` peer dependency: ```bash -npm install ../constructs/packages/kiro-constructs constructs +npm link @kiro/constructs +npm install constructs ``` ## Quick Start