Skip to content

Commit 0d2f7d6

Browse files
authored
chore: format README.md (goproxy#61)
Signed-off-by: Aofei Sheng <aofei@aofeisheng.com>
1 parent 546d218 commit 0d2f7d6

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

‎README.md‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,18 @@
77

88
A minimalist Go module proxy handler.
99

10-
Goproxy has fully implemented the [GOPROXY protocol](https://go.dev/ref/mod#goproxy-protocol). The goal of this project is
11-
to find the most dead simple way to provide a minimalist handler that can act as
12-
a full-featured Go module proxy for those who want to build their own proxies.
10+
Goproxy has fully implemented the [GOPROXY protocol](https://go.dev/ref/mod#goproxy-protocol). The goal of this project
11+
is to find the most dead simple way to provide a minimalist handler that can act as a full-featured Go module proxy for
12+
those who want to build their own proxies.
1313

1414
## Features
1515

1616
- Extremely easy to use
17-
- Three structs: [`goproxy.Goproxy`](https://pkg.go.dev/github.com/goproxy/goproxy#Goproxy), [`goproxy.GoFetcher`](https://pkg.go.dev/github.com/goproxy/goproxy#GoFetcher), and [`goproxy.DirCacher`](https://pkg.go.dev/github.com/goproxy/goproxy#DirCacher)
18-
- Two interfaces: [`goproxy.Fetcher`](https://pkg.go.dev/github.com/goproxy/goproxy#Fetcher) and [`goproxy.Cacher`](https://pkg.go.dev/github.com/goproxy/goproxy#Cacher)
17+
- Three structs: [`goproxy.Goproxy`](https://pkg.go.dev/github.com/goproxy/goproxy#Goproxy),
18+
[`goproxy.GoFetcher`](https://pkg.go.dev/github.com/goproxy/goproxy#GoFetcher), and
19+
[`goproxy.DirCacher`](https://pkg.go.dev/github.com/goproxy/goproxy#DirCacher)
20+
- Two interfaces: [`goproxy.Fetcher`](https://pkg.go.dev/github.com/goproxy/goproxy#Fetcher) and
21+
[`goproxy.Cacher`](https://pkg.go.dev/github.com/goproxy/goproxy#Cacher)
1922
- Built-in support for `GOPROXY`, `GONOPROXY`, `GOSUMDB`, `GONOSUMDB`, and `GOPRIVATE`
2023
- Supports serving under other Go module proxies by setting `GOPROXY`
2124
- Supports [proxying checksum databases](https://go.dev/design/25530-sumdb#proxying-a-checksum-database)
@@ -25,22 +28,23 @@ a full-featured Go module proxy for those who want to build their own proxies.
2528

2629
- To use this project programmatically, `go get` it:
2730

28-
```bash
29-
go get github.com/goproxy/goproxy
30-
```
31+
```bash
32+
go get github.com/goproxy/goproxy
33+
```
3134

32-
- To use this project from the command line, download the pre-built binaries
33-
from [here](https://github.com/goproxy/goproxy/releases) or build it from source:
35+
- To use this project from the command line, download the pre-built binaries from
36+
[here](https://github.com/goproxy/goproxy/releases) or build it from source:
3437

35-
```bash
36-
go install github.com/goproxy/goproxy/cmd/goproxy@latest
37-
```
38+
```bash
39+
go install github.com/goproxy/goproxy/cmd/goproxy@latest
40+
```
3841

39-
- To use this project with Docker, pull the pre-built images from [here](https://github.com/goproxy/goproxy/pkgs/container/goproxy):
42+
- To use this project with Docker, pull the pre-built images from
43+
[here](https://github.com/goproxy/goproxy/pkgs/container/goproxy):
4044

41-
```bash
42-
docker pull ghcr.io/goproxy/goproxy
43-
```
45+
```bash
46+
docker pull ghcr.io/goproxy/goproxy
47+
```
4448

4549
## Quick Start
4650

@@ -133,8 +137,8 @@ If you have any questions or ideas about this project, feel free to discuss them
133137

134138
## Contributing
135139

136-
If you would like to contribute to this project, please submit issues [here](https://github.com/goproxy/goproxy/issues) or
137-
pull requests [here](https://github.com/goproxy/goproxy/pulls).
140+
If you would like to contribute to this project, please submit issues [here](https://github.com/goproxy/goproxy/issues)
141+
or pull requests [here](https://github.com/goproxy/goproxy/pulls).
138142

139143
## License
140144

0 commit comments

Comments
 (0)