adding README for template-node, add dev command, bumping to 0.0.10

ProvableHQ · Oct 5, 2023 · c213e02 · c213e02
1 parent f36147e
commit c213e02
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/create-aleo-app/package.json b/create-aleo-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-aleo-app",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "type": "module",
   "license": "GPL-3.0",
   "collaborators": [

diff --git a/create-aleo-app/template-node/README.md b/create-aleo-app/template-node/README.md
@@ -0,0 +1,11 @@
+# Aleo + Node.js
+
+`npm start`
+
+Recommend Node.js 20+ for best performance.
+
+Will hang if using more threads than available for your machine. We are working
+on automatic thread detection but in the meantime you can manually set threads
+with `--threads` flag or in your code with `initThreadPool`.
+
+`npm start -- --threads 1`
diff --git a/create-aleo-app/template-node/package.json b/create-aleo-app/template-node/package.json
@@ -4,7 +4,8 @@
   "version": "0.0.0",
   "type": "module",
   "scripts": {
-    "start": "node index.js"
+    "start": "node index.js",
+    "dev": "node index.js"
   },
   "dependencies": {
     "@aleohq/sdk": "^0.6.1"