Skip to content

Commit

Permalink
docs(readme): update style format. (#475)
Browse files Browse the repository at this point in the history
  • Loading branch information
appleboy authored Oct 17, 2023
1 parent 9d67077 commit 0c3f5ea
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README-zh_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

![air](docs/air.png)

[English](README.md) | 简体中文
[English](README.md) | 简体中文

## 开发动机

Expand Down Expand Up @@ -137,7 +137,7 @@ air -c .air.toml -- -h

### Docker-compose

```
```yaml
services:
my-project-with-air:
image: cosmtrek/air
Expand Down Expand Up @@ -191,7 +191,7 @@ make install

### 发布新版本

```
```bash
# 1. checkout 到 master 分支
git checkout master
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ With go 1.18 or higher:
```bash
go install github.com/cosmtrek/air@latest
```

### Via install.sh

```bash
Expand All @@ -59,7 +60,6 @@ curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh
air -v
```


### Docker

Please pull this docker image [cosmtrek/air](https://hub.docker.com/r/cosmtrek/air).
Expand All @@ -74,7 +74,7 @@ docker run -it --rm \
-c <CONF>
```

<PROJECT> is your project path in container, eg: /go/example
`<PROJECT>` is your project path in container, eg: /go/example
if you want to enter the container, Please add --entrypoint=bash.

<details>
Expand All @@ -89,6 +89,7 @@ docker run -it --rm \
-p 9090:9090 \
cosmtrek/air
```

</details>

## Usage
Expand Down Expand Up @@ -146,7 +147,7 @@ air -c .air.toml -- -h

### Docker-compose

```
```yaml
services:
my-project-with-air:
image: cosmtrek/air
Expand All @@ -169,6 +170,7 @@ services:
## Installation and Usage for Docker users who don't want to use air image

`Dockerfile`

```Dockerfile
# Choose whatever you want, version >= 1.16
FROM golang:1.21-alpine
Expand All @@ -184,6 +186,7 @@ CMD ["air", "-c", ".air.toml"]
```

`docker-compose.yaml`

```yaml
version: "3.8"
services:
Expand Down Expand Up @@ -237,7 +240,7 @@ Pull requests are welcome.

### Release

```
```bash
# Checkout to master
git checkout master
Expand Down

0 comments on commit 0c3f5ea

Please sign in to comment.