add BUILD.md (closes: #244)

nostr-dev-kit · Jun 27, 2024 · 7699d49 · 7699d49
1 parent 97bafc5
commit 7699d49
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/BUILD.md b/BUILD.md
@@ -0,0 +1,21 @@
+# Build NDK
+
+NDK is structured as a monorepo using `pnpm` as the package manager.
+
+```
+git clone https://github.com/nostr-dev-kit/ndk
+cd ndk
+pnpm install
+pnpm build
+```
+
+If you only care about building ndk core and not the family of packages you can just
+
+```
+git clone https://github.com/nostr-dev-kit/ndk
+cd ndk
+pnpm install
+cd ndk
+pnpm build
+```
+