Skip to content

Commit a9c8d8c

Browse files
committed
chore: add readme
1 parent d616753 commit a9c8d8c

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# 🚤 quick-script
2+
3+
Ever wanted to quickly prototype an idea, but got stuck messing with tooling, dependencies, formatting, and everything else, only to forget what you set out to build in the first place? Well, I have.
4+
5+
`quick-script` is a simple utility for bootstrapping a script quickly.
6+
7+
# Usage
8+
9+
```
10+
npm create quick-script@latest --name update-users --engine bun
11+
```
12+
13+
Also available via `pnpm`, `bun`, and `yarn`.
14+
15+
## Options
16+
17+
All options are optional. If not provided, you will be prompted to enter them.
18+
19+
- `--name` - the name of your new project
20+
- `--engine` - the engine you want to use - either `bun`, `node`, or `deno`
21+
- `--target` - where you want your new project to live

0 commit comments

Comments
 (0)