Skip to content

Commit ce02454

Browse files
committed
Revert "Make README sound more natural and less AI-generated"
This reverts commit f2b8bac.
1 parent 6110f46 commit ce02454

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

README.md

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

88
## 🚀 Template Repository
99

10-
This is a **template repository** for building REST APIs with Go. Click the "Use this template" button above to create your own repository based on this template.
10+
This is a **template repository** for building production-ready and easily extendible REST APIs using Go. Click the "Use this template" button above to create your own repository based on this template.
1111

1212
## Overview
1313

14-
This template includes everything you need to build a REST API with Go - logging, middleware, database setup, testing, and deployment configs.
14+
This template follows best practices and includes a standardized project structure with all necessary components for building scalable microservices.
1515

1616
## Features
1717

1818
- Structured logging
19-
- Middleware (auth, CORS, etc.)
20-
- Config management
21-
- API docs with Swagger
22-
- Docker setup
23-
- GitHub Actions CI/CD
19+
- Middleware support (authentication, etc.)
20+
- Configuration management
21+
- API documentation with Swagger
22+
- Docker support
23+
- CI/CD pipeline with GitHub Actions
2424
- Database migrations
25-
- Tests
26-
- Makefile for common tasks
25+
- End-to-end testing
26+
- Makefile for common operations
2727

2828
The main ones are:
2929

@@ -44,31 +44,26 @@ The main ones are:
4444
## 🎯 Quick Start (Using Template)
4545

4646
### 1. Create Repository from Template
47-
4847
Click the **"Use this template"** button at the top of this repository, or use GitHub CLI:
4948

5049
```bash
5150
gh repo create my-go-api --template MitulShah1/golang-rest-api-template
5251
```
5352

5453
### 2. Clone Your New Repository
55-
5654
```bash
5755
git clone https://github.com/YOUR_USERNAME/my-go-api.git
5856
cd my-go-api
5957
```
6058

6159
### 3. Update Project Details
62-
6360
After creating your repository, update these files:
64-
6561
- `go.mod` - Update module name
6662
- `README.md` - Update project name and description
6763
- `.github/workflows/go.yml` - Update repository references if needed
6864
- `docker-compose.yml` - Update service names if needed
6965

7066
### 4. Start Development
71-
7267
```bash
7368
make help # See all available commands
7469
make env # Create .env file
@@ -115,7 +110,7 @@ golang-microservice-template/
115110

116111
### Prerequisites
117112

118-
- Go 1.21+
113+
- Go 1.21 or higher
119114
- Docker and Docker Compose
120115
- Make
121116

0 commit comments

Comments
 (0)