mirror of
https://github.com/CompeyDev/create-guilded-bot.git
synced 2024-12-12 12:50:35 +00:00
feat(cli): README
This commit is contained in:
parent
b0a78a8809
commit
284c7253c3
2 changed files with 19 additions and 1 deletions
18
packages/cli/README.md
Normal file
18
packages/cli/README.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# Create Guilded Bot
|
||||||
|
A CLI to quickly generate & bootstrap guilded.js bot projects. This tool enables you to start a bare-bones, minimal guilded bot project, with necessary tooling set up for you. To get started, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx create-guilded-bot@latest
|
||||||
|
# yarn
|
||||||
|
yarn create guilded-bot
|
||||||
|
# pnpm
|
||||||
|
pnpm create guilded-bot
|
||||||
|
```
|
||||||
|
|
||||||
|
You will be asked the following questions:
|
||||||
|
```bash
|
||||||
|
✔ Where should the project be initialized? … Directory
|
||||||
|
✔ Which flavor? … TypeScript/JavaScript
|
||||||
|
```
|
||||||
|
|
||||||
|
Answer accordingly, and you're good to go!
|
|
@ -10,7 +10,7 @@
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"author": "",
|
||||||
"license": "ISC",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"axios": "^1.1.3",
|
"axios": "^1.1.3",
|
||||||
"fs-extra": "^10.1.0",
|
"fs-extra": "^10.1.0",
|
||||||
|
|
Loading…
Reference in a new issue