Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
btopro authored Oct 16, 2024
1 parent 27664de commit c919655
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# 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

# Usage

```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
- `hax --type haxsite --name mysite --y` - create a new HAXsite (HAXcms, single site) `

## Site context
- listing what a site can do

# Alternative Usage

```bash
# also this will invoke 1x
npx @haxtheweb/create
# this is same as above, better windows CLI support
Expand Down

0 comments on commit c919655

Please sign in to comment.