Skip to content

Commit 3338218

Browse files
committed
docs: enhance README with AI/ML use cases and examples
- Add 'Large file friendly' feature highlighting AI models and datasets - Include 'AI & ML workflows' in use cases for model/data streaming - Enhance Large File Streaming section with AI model serving example - Position s3proxy for emerging AI infrastructure trends - Maintain core identity while expanding to AI developer audience Keywords: AI models, datasets, training data, ML workflows, model serving
1 parent 74467ef commit 3338218

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ s3proxy turns any S3 bucket into a high-performance web server. Perfect for serv
1717
- **Range requests** - Support for partial content and resumable downloads
1818
- **Express integration** - Drop into existing Node.js applications
1919
- **TypeScript support** - Full type safety and modern tooling
20+
- **Large file friendly** - Perfect for AI models, datasets, and media assets
2021

2122
## Quick Start
2223

@@ -223,6 +224,23 @@ s3proxy automatically handles HTTP Range requests for efficient streaming of lar
223224
curl --range 0-99 http://localhost:3000/large-video.mp4 -o partial.mp4
224225
```
225226

227+
### Large File Streaming
228+
229+
Perfect for streaming large assets without server storage:
230+
231+
```typescript
232+
// Stream AI models, datasets, or media files
233+
app.get('/models/:version/*', async (req: Request, res: Response) => {
234+
const stream = await proxy.get(req as HttpRequest, res as HttpResponse);
235+
stream.on('error', (err: any) => {
236+
res.status(err.statusCode || 500).end();
237+
}).pipe(res);
238+
});
239+
240+
// Now serve multi-GB files efficiently:
241+
// GET /models/v1/llama-7b.bin -> streams from S3 without local storage
242+
```
243+
226244
### Health Checks
227245

228246
Built-in health check endpoint for load balancers:
@@ -547,6 +565,7 @@ All configuration files are actively maintained and serve specific purposes in t
547565
- **File downloads** - Stream large files without server storage
548566
- **Media serving** - Video/audio streaming with range request support
549567
- **API backends** - Serve user uploads or generated content
568+
- **AI & ML workflows** - Stream models, datasets, and training data efficiently
550569
- **CDN alternative** - Cost-effective content delivery
551570

552571
## Performance

0 commit comments

Comments
 (0)