Skip to content

Commit bb3e90d

Browse files
authored
Revise README for e-commerce application clarity
Updated README to enhance project overview and features.
1 parent 606472c commit bb3e90d

1 file changed

Lines changed: 31 additions & 8 deletions

File tree

ecommerce-example/README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,38 @@
11
# E-commerce Example (kpt)
22

3-
## Overview
4-
A simple example showing how Kubernetes applications can be managed using kpt. Users can customize the app via configuration files instead of changing code.
3+
This is a simple e-commerce application example packaged using **kpt**.
54

6-
## Structure
7-
- `deployment.yaml` → Application Deployment
8-
- `service.yaml` → Service to expose the app
9-
- `Kptfile` → kpt package metadata
5+
---
106

11-
## Deployment
12-
Apply the Kubernetes resources:
7+
## 📌 Overview
138

9+
This project demonstrates how Kubernetes applications can be managed and customized using the **kpt toolchain**.
10+
11+
Instead of modifying code, users can change configuration using YAML files.
12+
13+
---
14+
15+
## 🚀 Features
16+
17+
- Simple Kubernetes Deployment using **nginx** (version pinned for reproducibility)
18+
- Service to expose the application internally
19+
- Easy-to-understand structure for beginners
20+
- Ready to extend with custom configuration
21+
22+
---
23+
24+
## 📂 Structure
25+
26+
- `deployment.yaml` → Defines the application Deployment
27+
- `service.yaml` → Exposes the application via a Service
28+
- `Kptfile` → Defines the kpt package metadata
29+
30+
---
31+
32+
## ⚙️ How to Use
33+
34+
### 1. Deploy the application
35+
36+
**Option A: Using kubectl only**
1437
```bash
1538
kubectl apply -f deployment.yaml -f service.yaml

0 commit comments

Comments
 (0)