Skip to content

Commit

Permalink
Improved Development docs in README
Browse files Browse the repository at this point in the history
I spent a couple minutes scratching my head about what 'yarn start'
was doing I usually just use this package on the command line.
Maybe this will save the next person some time.
  • Loading branch information
cathysarisky authored Oct 25, 2024
1 parent 23aeb0d commit 2d1cafd
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,17 @@ gscan.checkZip({

## Development

### Run
### Run in browser (for zip uploads)

- Either dev mode: `yarn dev`
- Or standard server: `yarn start`
- View: http://localhost:2369

### Run on command line

- zip file: `./bin/cli.js -z /path/to/your/theme.zip`
- directory: `./bin/cli.js /path/to/directory`

### Publish

(Core team only)
Expand Down

0 comments on commit 2d1cafd

Please sign in to comment.