docs: rewrite README.md
This commit is contained in:
35
README.md
35
README.md
@@ -1,15 +1,44 @@
|
|||||||
# g3n
|
# 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
|
```bash
|
||||||
bun install
|
bun install
|
||||||
```
|
```
|
||||||
|
|
||||||
To run:
|
## Usage
|
||||||
|
|
||||||
|
To run the tool, use the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun run index.ts
|
bun run g3n <command> [options]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 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.
|
This project was created using `bun init` in bun v1.2.18. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
|
||||||
Reference in New Issue
Block a user