diff --git a/packages/cli/README.md b/packages/cli/README.md new file mode 100644 index 0000000..4c08e6b --- /dev/null +++ b/packages/cli/README.md @@ -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! diff --git a/packages/cli/package.json b/packages/cli/package.json index 7588b74..de429fc 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -10,7 +10,7 @@ }, "keywords": [], "author": "", - "license": "ISC", + "license": "MIT", "dependencies": { "axios": "^1.1.3", "fs-extra": "^10.1.0",