@citruslime/create-boilerplate 1.0.0-beta.10 → 1.0.0-beta.11

package/README.md

@@ -1,22 +1,25 @@
-# Citrus-Lime UI Library Boilerplate Creation
+# Citrus-Lime UI Library Create Boilerplate Script
+
+A create package for initialising Citrus-Lime web apps.
 
 ![version](https://img.shields.io/npm/v/@citruslime/create-boilerplate/latest)
 ![version next](https://img.shields.io/npm/v/@citruslime/create-boilerplate/next)
-![license](https://img.shields.io/npm/l/@citruslime/create-boilerplate)
 
 - ⚡ [NPM Package](https://www.npmjs.com/package/@citruslime/create-boilerplate)
 - 📖 [Documentation & API](https://uilibrary.citruslime.com)
 - 📌 [Citrus-Lime Ltd](https://www.citruslime.com)
 
-## Running the script
 
-⚠️ All of the parameters listed below are required.
+`npm init @citruslime/boilerplate TargetDirectory`
+
+or
 
-#### Script signature
-```yarn create @citruslime/boilerplate TargetDirectory```
+`yarn create @citruslime/boilerplate TargetDirectory`
 
 - **TargetDirectory**
-  - _A relative folder path for the script to create the boilerplate app_
+  - A relative folder path for the script to create the boilerplate app
+  - *Optional* - will be prompted for, if not provided
+
+e.g.
 
-#### Example Script Execution
-```yarn create @citruslime/boilerplate ./ui/customer```
+`yarn create @citruslime/boilerplate ./ui/customer`

package/main.mjs

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 import { execSync } from 'child_process';
 import { existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync, writeFileSync } from 'fs';
 import { dirname, join } from 'path';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@citruslime/create-boilerplate",
-    "version": "1.0.0-beta.10",
+    "version": "1.0.0-beta.11",
     "author": {
         "name": "Citrus-Lime Ltd",
         "url": "https://citruslime.com"
@@ -16,8 +16,7 @@
     ],
     "main": "main.mjs",
     "bin": {
-        "create-boilerplate": "main.mjs",
-        "cva": "main.mjs"
+        "create-boilerplate": "main.mjs"
     },
     "engines": {
         "node": ">=14.0.0"