Skip to content

Commit 14329b9

Browse files
committed
chore: update README formatting and remove emoji from section headers
1 parent 1522447 commit 14329b9

File tree

1 file changed

+28
-31
lines changed

1 file changed

+28
-31
lines changed

README.md

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🖼️ Image Optimize
1+
# Image Optimize
22

33
**High-performance microservice for on-the-fly image optimization, resizing, and format conversion**
44

@@ -16,29 +16,29 @@
1616

1717
---
1818

19-
## 📋 Overview
19+
## Overview
2020

2121
**Image Optimize** is a lightweight, production-ready microservice that optimizes images dynamically. Built with [NestJS](https://nestjs.com/) and powered by [Sharp](https://sharp.pixelplumbing.com/), it delivers exceptional performance for modern web applications.
2222

2323
### Why Image Optimize?
2424

2525
Optimizing images is critical for web performance — reducing page load times, saving bandwidth, and improving SEO rankings. This microservice handles all optimization on-the-fly, requiring no pre-processing or storage of optimized variants.
2626

27-
### Features
27+
### Features
2828

2929
| Feature | Description |
3030
|---------|-------------|
31-
| 🔄 **Dynamic Resizing** | Resize images to any width, perfect for responsive designs |
32-
| 🗜️ **Smart Compression** | Reduce file sizes with configurable quality settings (1-100) |
33-
| 🎨 **Modern Formats** | Convert to WebP, AVIF, JPEG, or PNG on demand |
34-
| **High Performance** | Average processing time ~200ms per image |
35-
| 📊 **Prometheus Metrics** | Built-in `/metrics` endpoint for monitoring |
36-
| 🔐 **Security Controls** | Allowlist for sources, size restrictions, Basic Auth support |
37-
| 🐳 **Docker Ready** | Production-optimized container image |
31+
| **Dynamic Resizing** | Resize images to any width, perfect for responsive designs |
32+
| **Smart Compression** | Reduce file sizes with configurable quality settings (1-100) |
33+
| **Modern Formats** | Convert to WebP, AVIF, JPEG, or PNG on demand |
34+
| **High Performance** | Average processing time ~200ms per image |
35+
| **Prometheus Metrics** | Built-in `/metrics` endpoint for monitoring |
36+
| **Security Controls** | Allowlist for sources, size restrictions, Basic Auth support |
37+
| **Docker Ready** | Production-optimized container image |
3838

3939
---
4040

41-
## 🚀 Quick Start
41+
## Quick Start
4242

4343
### Using Docker (Recommended)
4444

@@ -63,7 +63,7 @@ http://localhost:3000/optimize?src=https://example.com/photo.jpg&size=1200&forma
6363

6464
---
6565

66-
## 📖 API Reference
66+
## API Reference
6767

6868
### `GET /optimize`
6969

@@ -101,7 +101,7 @@ curl http://localhost:3000/metrics
101101

102102
---
103103

104-
## ⚙️ Configuration
104+
## Configuration
105105

106106
Configure the service using environment variables:
107107

@@ -151,7 +151,7 @@ For sources requiring authentication:
151151

152152
---
153153

154-
## 🐳 Deployment
154+
## Deployment
155155

156156
### Docker Compose
157157

@@ -233,35 +233,32 @@ spec:
233233

234234
---
235235

236-
## 🧩 Frontend Integration
236+
## Frontend Integration
237237

238238
### React Component
239239

240240
Use our official React component for seamless integration:
241241

242242
```bash
243-
npm install @mts/image-optimize-react
243+
npm install @mts-pjsc/image-optimize
244244
```
245245

246246
```jsx
247-
import { OptimizedImage } from '@mts/image-optimize-react';
248-
249-
function App() {
250-
return (
251-
<OptimizedImage
252-
src="https://cdn.example.com/photo.jpg"
253-
optimizerUrl="https://your-optimizer.com/optimize"
254-
alt="Optimized photo"
255-
/>
256-
);
257-
}
247+
import { Image } from '@mts-pjsc/image-optimize';
248+
249+
<Image
250+
alt="Optimized image"
251+
src="https://cdn.example.com/photo.jpg"
252+
/>
258253
```
259254

255+
The component automatically handles size detection and format negotiation with the optimization service.
256+
260257
👉 [image-optimize-react on GitHub](https://github.com/MobileTeleSystems/image-optimize-react)
261258

262259
---
263260

264-
## 🛠️ Development
261+
## Development
265262

266263
### Prerequisites
267264

@@ -309,7 +306,7 @@ src/
309306
310307
---
311308
312-
## 🤝 Contributing
309+
## Contributing
313310
314311
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
315312
@@ -321,13 +318,13 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
321318
322319
---
323320
324-
## 📄 License
321+
## License
325322
326323
This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.
327324
328325
---
329326
330-
## 🔗 Links
327+
## Links
331328
332329
- [Docker Hub](https://hub.docker.com/r/mtsrus/image-optimize)
333330
- [GitHub Repository](https://github.com/MobileTeleSystems/image-optimize)

0 commit comments

Comments
 (0)