119 lines
3.8 KiB
Markdown
119 lines
3.8 KiB
Markdown
# {project-name}
|
|
|
|
<!-- Replace {owner} and {repo} throughout this file -->
|
|
|
|
[](https://go.dev/) [](./LICENSE) [](https://github.com/{owner}/{repo}/actions) [](https://codecov.io/gh/{owner}/{repo}) [](https://goreportcard.com/report/github.com/{owner}/{repo}) [](https://pkg.go.dev/github.com/{owner}/{repo})
|
|
|
|
<!-- Additional badges (pick what's relevant):
|
|
[](https://github.com/{owner}/{repo}/releases)
|
|
[](https://github.com/{owner}/{repo}/releases)
|
|
[](https://hub.docker.com/r/{owner}/{repo})
|
|
-->
|
|
|
|
<!-- 1-2 sentences: what does this project do and who is it for? -->
|
|
|
|
<!-- Show the project in action: code snippet, GIF, screenshot, or video.
|
|
For libraries: show a minimal working code example.
|
|
For CLIs/tools: a GIF or screenshot is often more effective. -->
|
|
|
|
```go
|
|
// Minimal working example showing the most common use case
|
|
```
|
|
|
|
## 🚀 Getting Started
|
|
|
|
<!-- For libraries: -->
|
|
|
|
```bash
|
|
go get github.com/{owner}/{repo}
|
|
```
|
|
|
|
```go
|
|
package main
|
|
|
|
import "github.com/{owner}/{repo}"
|
|
|
|
func main() {
|
|
// Minimal working example
|
|
}
|
|
```
|
|
|
|
<!-- For applications, uncomment and use this instead:
|
|
|
|
### Pre-built binaries
|
|
|
|
Download from [GitHub Releases](https://github.com/{owner}/{repo}/releases/latest).
|
|
|
|
| Platform | Architecture | Download |
|
|
| -------- | ------------ | ----------------------------------------------------------------------------------------------- |
|
|
| Linux | amd64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-linux-amd64) |
|
|
| Linux | arm64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-linux-arm64) |
|
|
| macOS | amd64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-darwin-amd64) |
|
|
| macOS | arm64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-darwin-arm64) |
|
|
| Windows | amd64 | [Download](https://github.com/{owner}/{repo}/releases/latest/download/{repo}-windows-amd64.exe) |
|
|
|
|
### From source
|
|
|
|
```bash
|
|
go install github.com/{owner}/{repo}@latest
|
|
```
|
|
|
|
### Docker
|
|
|
|
```bash
|
|
docker pull {registry}/{owner}/{repo}:latest
|
|
docker run --rm {registry}/{owner}/{repo}:latest --help
|
|
```
|
|
|
|
### Homebrew (macOS)
|
|
|
|
```bash
|
|
brew install {owner}/{repo}
|
|
```
|
|
|
|
### APT (debian/ubuntu)
|
|
|
|
```bash
|
|
apt install {package}
|
|
```
|
|
|
|
-->
|
|
|
|
## ✨ Features
|
|
|
|
<!-- Very detailed feature descriptions, organized by area.
|
|
This is the longest section of the README.
|
|
Use headings, tables, and code examples generously. -->
|
|
|
|
### Feature Area 1
|
|
|
|
<!-- Description with code examples -->
|
|
|
|
### Feature Area 2
|
|
|
|
<!-- Description with code examples -->
|
|
|
|
## 🤝 Contributing
|
|
|
|
Please read the [contributing guide](CONTRIBUTING.md) before submitting a PR.
|
|
|
|
<!-- Or if the contributing guide is very short:
|
|
|
|
```bash
|
|
# Build
|
|
go build -o myapp ./cmd/main.go
|
|
|
|
# Run unit tests
|
|
go test -race ./...
|
|
|
|
# Run integration tests
|
|
go test -race -tags=integration -timeout=300s ./...
|
|
|
|
# Run linter
|
|
golangci-lint run --fix ./...
|
|
-->
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|