Skip to content

Commit 83fb1c4

Browse files
committed
updated read me
1 parent ce02454 commit 83fb1c4

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 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 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.
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.
1111

1212
## Overview
1313

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

1616
## Features
1717

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

2828
The main ones are:
2929

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

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

4950
```bash
5051
gh repo create my-go-api --template MitulShah1/golang-rest-api-template
5152
```
5253

5354
### 2. Clone Your New Repository
55+
5456
```bash
5557
git clone https://github.com/YOUR_USERNAME/my-go-api.git
5658
cd my-go-api
5759
```
5860

5961
### 3. Update Project Details
62+
6063
After creating your repository, update these files:
64+
6165
- `go.mod` - Update module name
6266
- `README.md` - Update project name and description
6367
- `.github/workflows/go.yml` - Update repository references if needed
6468
- `docker-compose.yml` - Update service names if needed
6569

6670
### 4. Start Development
71+
6772
```bash
6873
make help # See all available commands
6974
make env # Create .env file
@@ -110,7 +115,7 @@ golang-microservice-template/
110115

111116
### Prerequisites
112117

113-
- Go 1.21 or higher
118+
- Go 1.21+
114119
- Docker and Docker Compose
115120
- Make
116121

0 commit comments

Comments
 (0)