fix: npm readme

nearform · Oct 25, 2023 · e967afa · e967afa
1 parent 321141e
commit e967afa
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/npm/README.md b/npm/README.md
diff --git a/npm/README.md b/npm/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/npm/docs.md b/npm/docs.md
@@ -0,0 +1,7 @@
+# Publish the initium CLI on NPM
+
+This folder is here to generate an npm package that will allow user to run initium with either npm or npx.
+
+NOTE: This package doesn't contain the binaries.
+
+You can check the code in the `script` folder to see how this package will detect the platform and architecture of your machine and download the relevant binary from the github releases of this repo.