chore: update README.md

nearform · Sep 6, 2023 · 21ba058 · 21ba058
1 parent 9549d8d
commit 21ba058
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,6 +4,18 @@ A single static binary that can run on any CI to build your code and deploy it i
 
 All with a nice development workflow in mind like ephemeral environment for your PRs.
 
+### Running the CLI
+
+The CLI is currently published on [NPM](https://www.npmjs.com/package/initium). You can run it using
+
+```
+npx initium-cli
+```
+
+That will install the Initium CLI in your folder's `node_modules`.
+
+We recommend you not to try installing the CLI globally if you don't use a Node.js version manager (like `nvm`), as you can run into permission errors.
+
 ### Pre-requisites
 
 1. GoLang

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "initium-cli",
+  "name": "initium",
   "binaryName": "initium-cli",
   "version": "0.3.0",
   "description": "A single static binary that can run on any CI to build your code and deploy it in a single step.",