From 421e889af5d7ca65573d61e817eee1c0aacba757 Mon Sep 17 00:00:00 2001 From: RitikaT26 <120569968+RitikaT26@users.noreply.github.com> Date: Fri, 1 May 2026 13:01:48 +0530 Subject: [PATCH] Update README with new sections and formatting Added sections for use cases, system architecture, performance, security, comparison, and philosophy. --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8c5fc33..5898191 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ > PDF tools that respect your privacy โ€” merge and split documents entirely in the browser. - + [![React](https://img.shields.io/badge/React-19-61DAFB?style=flat-square&logo=react&logoColor=black)](https://react.dev/) [![Vite](https://img.shields.io/badge/Vite-8-646CFF?style=flat-square&logo=vite&logoColor=white)](https://vite.dev/) @@ -17,7 +17,7 @@ [![CI Pipeline](https://github.com/jhasourav07/quickpdf/actions/workflows/ci.yml/badge.svg)](https://github.com/jhasourav07/quickpdf/actions/workflows/ci.yml) **[๐Ÿš€ Try the Live Demo Here](https://quickpdff.vercel.app/)** - + --- Every major PDF tool โ€” Smallpdf, ILovePDF, Adobe Acrobat Online โ€” routes your files through a remote server. You upload a confidential contract, a financial statement, a medical record โ€” and it passes through infrastructure you don't control. @@ -141,8 +141,52 @@ QuickPDF uses [`pdf-lib`](https://pdf-lib.js.org/) โ€” a pure JavaScript library - [ ] Add Page Numbers โ€” Auto-stamp sequential numbers on footers - [ ] Extract Text (OCR) โ€” Pull readable text directly to clipboard - [ ] Protect/Unlock PDF โ€” Add or remove passwords locally -- [ ] Edit Pdf - Edit pdf locally on your browser +- [ ] Edit PDF - Edit PDF locally on your browser + +--- +## ๐Ÿงช Use Cases + +- Invoice generation +- Automated reports +- Web page archiving +- Email attachments +- Competitor monitoring +- Compliance documentation + +--- + +## ๐Ÿ—๏ธ System Architecture + +Client โ†’ API Gateway โ†’ Headless Chrome Renderer โ†’ PDF Generator โ†’ Response + +--- + +## ๐Ÿ“ˆ Performance + +- Fast Chrome-based rendering +- Batch processing support +- Stateless architecture +- Designed for production-scale workloads + +--- + +## ๐Ÿ” Security +- API key authentication +- Rate limiting +- SSRF protection +- Isolated execution environment +- HTTPS enforced + +--- + +## ๐Ÿ“Š Comparison + +| Tool | Limitation | QuickPDF Advantage | +|------|-----------|--------------------| +| Puppeteer | Complex setup | API-first simplicity | +| wkhtmltopdf | Outdated rendering | Modern Chrome engine | +| Custom scripts | Hard to scale | Fully managed service | --- ## Contributing @@ -164,6 +208,13 @@ QuickPDF is architected so that a breach of the application itself **cannot expo If you discover a vulnerability, please open a [GitHub Security Advisory](https://github.com/jhasourav07/quickpdf/security/advisories/new) rather than a public issue. --- +## Philosophy + +QuickPDF is built as production-grade rendering infrastructure focused on: + +- Reliability +- Scalability +- Developer experience ## License