Merge branch 'newReadme' of
git@github.com:Stirling-Tools/Stirling-PDF.git into newReadme
This commit is contained in:
@@ -4,7 +4,7 @@
|
||||
|
||||
# Stirling PDF – The Open-Source PDF Platform
|
||||
|
||||
Stirling PDF is a powerful, open-source PDF editing Platform. Run it as a personal desktop app, in the browser, or deploy it on your own servers with a private API. Edit, sign, redact, convert, and automate PDFs without sending documents to third‑party services.
|
||||
Stirling PDF is a powerful, open-source PDF editing platform. Run it as a personal desktop app, in the browser, or deploy it on your own servers with a private API. Edit, sign, redact, convert, and automate PDFs without sending documents to third‑party services.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://hub.docker.com/r/stirlingtools/stirling-pdf">
|
||||
@@ -27,37 +27,55 @@ Stirling PDF is a powerful, open-source PDF editing Platform. Run it as a person
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
- **Everywhere you work** – Desktop client, browser UI, and self‑hosted server with a private API.
|
||||
- **Everywhere you work** – Desktop client, browser UI, and self-hosted server with a private API.
|
||||
- **50+ PDF tools** – Edit, merge, split, sign, redact, convert, OCR, compress, and more.
|
||||
- **Automation & workflows** – No‑code pipelines and APIs to process millions of PDFs.
|
||||
- **Enterprise‑grade** – SSO, RBAC, auditing, and flexible on‑prem deployments.
|
||||
- **Developer platform** – REST APIs, SDKs, and on‑prem AI integrations for PDF‑centric apps.
|
||||
- **Automation & workflows** – No-code pipelines direct in UI with APIs to process millions of PDFs.
|
||||
- **Enterprise‑grade** – SSO, auditing, and flexible on‑prem deployments.
|
||||
- **Developer platform** – REST APIs available for nearly all tools to integrate into your existing systems.
|
||||
- **Global UI** – Interface available in 40+ languages.
|
||||
|
||||
For a full and always up to-date feature list, see the docs: **https://docs.stirlingpdf.com**
|
||||
For a full feature list, see the docs: **https://docs.stirlingpdf.com**
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
The fastest way to get started is with Docker:
|
||||
|
||||
```bash
|
||||
docker run -p 8080:8080 docker.stirlingpdf.com/stirlingtools/stirling-pdf
|
||||
```
|
||||
|
||||
Then open: http://localhost:8080
|
||||
|
||||
For full installation options (including desktop and Kubernetes), see **https://docs.stirlingpdf.com/#documentation-guide**.
|
||||
|
||||
---
|
||||
|
||||
## Resources
|
||||
|
||||
- **Documentation**: https://docs.stirlingpdf.com
|
||||
- **Homepage**: https://stirling.com
|
||||
- **API Docs**: https://registry.scalar.com/@stirlingpdf/apis/stirling-pdf-processing-api/
|
||||
- **Server Plan & Enterprise**: https://docs.stirlingpdf.com/Paid-Offerings
|
||||
|
||||
---
|
||||
|
||||
## Support
|
||||
|
||||
- **Community Discord**: https://discord.gg/HYmhKj45pU
|
||||
- **Bug Reports**: https://github.com/Stirling-Tools/Stirling-PDF/issues
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
|
||||
For development setup, see the [Developer Guide](DeveloperGuide.md).
|
||||
|
||||
For adding translations, see the [Translation Guide](devGuide/HowToAddNewLanguage.md).
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
This project is open-core licensed under the terms in [LICENSE](LICENSE).
|
||||
|
||||
Stirling PDF is open-core. See [LICENSE](LICENSE) for details.
|
||||
|
||||
Reference in New Issue
Block a user