diff --git a/README.md b/README.md index b2ac8db..655e875 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,44 @@ # g3n -To install dependencies: +`g3n` is a command-line tool for generating code, managing Docker, and other development tasks. + +## Installation + +To install the dependencies, run the following command: ```bash bun install ``` -To run: +## Usage + +To run the tool, use the following command: ```bash -bun run index.ts +bun run g3n [options] ``` -This project was created using `bun init` in bun v1.2.18. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. +### Available Commands + +* `app-create`: Creates a new application. +* `code`: Generates code. +* `compose`: Manages Docker Compose. +* `docker-file`: Manages Dockerfiles. +* `frp`: Manages FRP. +* `port`: Manages ports. +* `route`: Manages routes. +* `generate-env`: Generates environment files. + +## Dependencies + +This project uses the following main dependencies: + +* `@babel/parser` +* `@babel/traverse` +* `@babel/types` +* `dedent` +* `dotenv` +* `minimist` +* `ora` + +This project was created using `bun init` in bun v1.2.18. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. \ No newline at end of file