final startup docs and yarn scripts

shapeshift · Jun 20, 2024 · c8c2269 · c8c2269
1 parent f23f2c6
commit c8c2269
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/scripts/hotWalletCli/README.md b/scripts/hotWalletCli/README.md
@@ -0,0 +1,18 @@
+## Prerequisites
+
+- NodeJS (v18+): https://nodejs.org/en/download/package-manager
+- Yarn: https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable
+
+## Setup
+
+- Install dependencies:
+  ```bash
+  yarn
+  ```
+
+## Running
+
+- Run script:
+  ```bash
+  yarn start
+  ```
diff --git a/scripts/hotWalletCli/package.json b/scripts/hotWalletCli/package.json
@@ -7,6 +7,10 @@
     "node": ">=18"
   },
   "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf node_modules",
+    "start": "tsx index.ts"
+  },
   "dependencies": {
     "@inquirer/core": "^8.2.2",
     "@inquirer/prompts": "^5.0.5",