Skip to content

Commit c2488ac

Browse files
committed
docs/ updated readme
1 parent 1bc81e9 commit c2488ac

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

readme.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77

88
A high-performance and secure REST/GraphQL API built with Rust, MongoDB & Redis for cleaning email subscriber lists. Maintains sender reputation by validating, deduplicating, and pruning inactive emails.
99

10-
## 🚀 Features
10+
## Features
1111

1212
- **Scalable Architecture**: Built with Rust and optimized for horizontal scaling.
1313
- **Security First**: OAuth2/JWT authentication, rate limiting, and input validation.
1414
- **Observability**: Integrated logging, metrics, and distributed tracing.
1515
- **Multi-Protocol Support**: REST, GraphQL, or gRPC endpoints (choose as needed).
1616

17-
## Validations
17+
## Validations
1818

1919
Detect and handle invalid email addresses before they take some space in your database, cause delivery issues or harm your sender score.
2020

@@ -58,7 +58,7 @@ Follows RFC specifications by checking A/AAAA records if MX records are missing.
5858

5959
Checks among a list of 106,543 disposable email domains, the largest database of disposable emails out there, updated daily.
6060

61-
## 🛠 Tech Stack
61+
## Tech Stack
6262

6363
| Category | Tools |
6464
| -------------- | --------------------------------------- |
@@ -69,7 +69,7 @@ Checks among a list of 106,543 disposable email domains, the largest database of
6969
| **Auth** | Auth0/Clerk/PASETO/OAuth2 |
7070
| **Monitoring** | Prometheus + Grafana, ELK Stack |
7171

72-
## 📦 Getting Started
72+
## Getting Started
7373

7474
### Prerequisites
7575

@@ -88,7 +88,7 @@ Checks among a list of 106,543 disposable email domains, the largest database of
8888
cargo build
8989
```
9090

91-
### 🔧 Environment Setup
91+
### Environment Setup
9292

9393
Configure your `.env` file:
9494

@@ -103,7 +103,7 @@ REDIS_URL=redis://127.0.0.1:6379
103103
REDIS_CACHE_TTL=86400 # 1 day in seconds
104104
```
105105
106-
### 🏗️ Running the Server
106+
### Running the Server
107107
108108
```bash
109109
# Development (hot-reload)
@@ -113,7 +113,7 @@ cargo watch -x run
113113
cargo build --release
114114
```
115115
116-
### 🚨 Contributing
116+
### Contributing
117117
118118
- Fork the repository.
119119
- Create a branch:
@@ -126,11 +126,11 @@ git checkout -b feat/issue-number-issue-name
126126
- Follow Conventional Commits.
127127
- Submit a PR with tests and documentation.
128128
129-
### 📄 License
129+
### License
130130
131131
MIT License.
132132
133-
### 🌟 Future Roadmap
133+
### Future Roadmap
134134
135135
##### **Phase 1: Core Setup & Validation (Sprint 1-2)**
136136

0 commit comments

Comments
 (0)