Skip to content

Commit 96d8e4b

Browse files
authored
Update README.md
1 parent 452a76f commit 96d8e4b

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,39 +28,36 @@
2828

2929
### **Installation**
3030
```bash
31-
# ======================
31+
3232
# Clone repository
33-
# ======================
3433
git clone https://github.com/SSobol77/csv-db-sdk.git
3534
cd csv-db-sdk
3635

37-
# ======================
38-
# Installation Guide
39-
# ======================
40-
41-
### Basic Installation (Core Functionality)
36+
# Basic Installation (Core Functionality)
4237
pip install csv-db-sdk
4338

44-
### Development Setup (Testing + Coverage)
39+
# Development Setup (Testing + Coverage)
4540
pip install "csv-db-sdk[testing]"
4641

47-
### Full Installation (All Features)
42+
# Full Installation (All Features)
4843
pip install "csv-db-sdk[full]"
44+
```
45+
<br>
4946

50-
# ======================
51-
# Semantic Versioning Policy
52-
# ======================
47+
### Semantic Versioning Policy
5348

54-
### Dependency Management
49+
##### Dependency Management
5550
Strict SemVer compliance for all dependencies:
5651
psycopg2-binary ~= 2.9.9 # Compatible with 2.9.x (2.9.9 ≤ version < 3.0)
5752
boto3 ~= 1.34.112 # Compatible with 1.34.x (1.34.112 ≤ version < 2.0)
5853

59-
### Version Guarantees
54+
##### Version Guarantees
6055
- Major versions (X.0.0): Breaking API changes
6156
- Minor versions (1.X.0): Backwards-compatible features
6257
- Patch versions (1.0.X): Backwards-compatible bug fixes
6358

59+
<br>
60+
6461
### Compatibility Matrix
6562
| Component | Supported Versions | Stability Level |
6663
|-----------------|--------------------|-----------------|
@@ -69,17 +66,18 @@ boto3 ~= 1.34.112 # Compatible with 1.34.x (1.34.112 ≤ version < 2.0
6966
| Oracle DB | 19c-23c | Verified |
7067
| MongoDB | 4.4-7.0 | Production |
7168

72-
# ======================
73-
# Upgrade Recommendations
74-
# ======================
69+
<br>
7570

71+
### Upgrade Recommendations
72+
73+
```bash
7674
### Safe Upgrade Path
7775
pip install --upgrade-strategy eager "csv-db-sdk>=1.2,<2.0"
7876

7977
### Version Pinning Example
8078
echo "csv-db-sdk==1.2.3" >> production-requirements.txt
81-
8279
```
80+
<br>
8381

8482
### **Basic Usage**
8583
```python
@@ -103,6 +101,8 @@ pg.export_csv("analytics/results.csv", "sales_data")
103101

104102
---
105103

104+
<br>
105+
106106
## 🏗 **Architecture**
107107

108108
```bash

0 commit comments

Comments
 (0)