create-cubing-app 0.35.6-rc21 → 0.35.6-rc23

package/README.md

@@ -1,6 +1,6 @@
-# `cubing-app-template`
+# `create-cubing-app`
 
-This is a template project for project using [`cubing.js`](https://github.com/cubing/cubing.js) with `node` and `npm`. In an editor like VSCode, this will give you nice imports, autocompletions, and other TypeScript benefits.
+This is a tool to initialize for apps using [`cubing.js`](https://github.com/cubing/cubing.js) with `node` and `npm`. In an editor like VSCode, this will give you nice imports, autocompletions, and other TypeScript benefits.
 
 See <https://js.cubing.net/cubing/> for (in-progress) documentation on `cubing.js`. If you think you have any issues, don't hesitate to [file an issue here](https://github.com/cubing/cubing.js/issues/new/choose).
 
@@ -9,11 +9,9 @@ See <https://js.cubing.net/cubing/> for (in-progress) documentation on `cubing.j
 Make sure `node` is installed first (which will also install `npm`): <https://nodejs.org/en/download/>
 
 ```shell
-# Set up the project for the first time
-git clone https://github.com/cubing/cubing-app-template my-app && cd my-app
-npm install
+npm create cubing-app my-cubing-project
 
-# Start working on the project at http://localhost:1234
+cd my-cubing-project
 npm run dev
 ```
 

package/bin/create-cubing-app.js

@@ -23,13 +23,13 @@ await execPromise("npm install validate-npm-package-name", {
 });
 
 function badPackageName() {
-	stderr.write(`Please specify a valid project name!
-For example:
+	stderr.write(`Usage:
 
-    npm create cubing-app my-cubing-project
+    npm create cubing-app <project folder name>
 
+The project folder name should consist of only letters, numbers, dashes, and underscores.
 `);
-	exit(1);
+	exit(0);
 }
 const packageName = process.argv[2];
 if (!packageName) {
@@ -63,7 +63,7 @@ const initialPackageJSON = {
 			"node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"src\", dev: false, outDir: \"dist/web\"}))' && echo '' && echo 'Your app has been built in: ./dist/web' && echo ''",
 		dev: 'node -e \'import("barely-a-dev-server").then(s => s.barelyServe({entryRoot: "src"}))\'',
 		clean: "rm -rf ./dist",
-		"upgrade-cubing": "npm install cubing@latest",
+		"upgrade-cubing": "npm install --save cubing@latest",
 	},
 };
 await writeFile(
@@ -108,5 +108,5 @@ To create an optimized build of your app that can be uploaded to a file server,
 
 When a new version of \`cubing.js\` is released in the future, you can upgrade using:
 
-    npm install cubing@latest
+    npm install --save cubing@latest
 `);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "create-cubing-app",
-  "version": "0.35.6-rc21",
+  "version": "0.35.6-rc23",
   "type": "module",
   "bin": "./bin/create-cubing-app.js",
   "scripts": {
     "build": "node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"./src\", dev: false, outDir: \"dist/web\"}))' && echo '' && echo 'Your app has been built in: ./dist/web' && echo ''",
     "dev": "node -e 'import(\"barely-a-dev-server\").then(s => s.barelyServe({entryRoot: \"./src\"}))'",
-    "upgrade-cubing": "npm install cubing@latest",
+    "upgrade-cubing": "npm install --save cubing@latest",
     "clean": "rm -rf ./dist"
   },
   "dependencies": {