@haxtheweb/create 9.0.5 → 9.0.8

package/README.md

@@ -1,20 +1,56 @@
 # HAX The CLI
 Rapidly build web components for the Web that work with HAX. HAX The Web's CLI tools empower you to rapidly..
-- start making Lit based web components using the HAX design system and tools
 
-## Future state
-- Create new HAX sites and administer them from the CLI
-- Create new themes for HAXcms
-- Interface w/ docs / AI agent on website
+```bash
+# this allows you to then use hax command
+npm install @haxtheweb/create --global
+# then run
+hax
+```
+
+# Commands
+
+## Default / global / new context
+- `hax` - fun ascii art and interactive CLI (via [clack](https://www.clack.cc/) )
+- `hax --name my-element --y` - Make a new HAX capable, i18n wired, Design system (DDD) driven web component
+  -  if in a monorepo root, will place in correct location / inherit settings
+- `hax --type haxsite --name mysite --y` - create a new HAXsite (HAXcms, single site)
+
+## Site  context
+- listing stats
+- launch site
+- publish to surge.sh (if installed)
+
+## web component context
+- launch element
 
-# Usage
+# Alternative Usage
 
 ```bash
+# also this will invoke 1x
 npx @haxtheweb/create
-#or
+# this is same as above, better windows CLI support
 npm init @haxtheweb
 ```
 
+## Usage in other programs
+https://stackoverflow.com/questions/69208298/use-node-bins-without-installing-the-package-globally explains it but you should be able to use the CLI as part of another project as follows:
+```json
+{
+  "scripts": {
+    "hax": "hax"
+  }
+}
+```
+
+```bash
+# script creating a new element called my-element w/ all defaults
+npm run hax -- --name my-element --y
+```
+
+## Windows problems?
+Try setting a different cache path to load from `npm config set cache C:\tmp\nodejs\npm-cache --global`
+
 Follow the prompts and let's HAX the Web together!
 
 ## Web component