diff --git a/README.md b/README.md index a149a4e8..e4235cd4 100644 --- a/README.md +++ b/README.md @@ -24,121 +24,154 @@
## Overview -DocuElevate automates the handling, extraction, and processing of documents using a variety of services, including: +DocuElevate is an intelligent document processing system that automates the ingestion, OCR, AI-powered metadata extraction, and distribution of documents. It supports a wide range of AI providers, OCR engines, and cloud storage destinations out of the box. -- **AI Provider** (pluggable – OpenAI, Anthropic, Gemini, Ollama, OpenRouter, Portkey, and more) for metadata extraction and text refinement. -- **Dropbox**, **Nextcloud**, and **Google Drive** for file storage and uploads. -- **Paperless NGX** for document indexing and management. -- **Azure Document Intelligence** for OCR on PDFs. -- **Gotenberg** for file-to-PDF conversions. -- **Authentik** for authentication and user management. +**Key capabilities:** -It is designed for flexibility and configurability through environment variables, making it easily customizable for different workflows. The system can fetch documents from multiple IMAP mailboxes, process them (OCR, metadata extraction, PDF conversion), and store them in the desired destinations. +- **AI-Powered Metadata Extraction** — pluggable AI providers including OpenAI, Anthropic Claude, Google Gemini, Ollama (local), OpenRouter, Portkey, and Azure OpenAI via LiteLLM +- **Multi-Engine OCR** — Azure Document Intelligence, Tesseract, EasyOCR, Mistral OCR, Google Cloud Document AI, and AWS Textract with configurable merge strategies +- **12 Storage Destinations** — Dropbox, Google Drive, OneDrive, Amazon S3, Nextcloud, WebDAV, FTP, SFTP, iCloud Drive, Email (SMTP), Paperless-ngx, and Rclone +- **Multi-Channel Ingestion** — web upload, browser extension, mobile app, CLI, REST API, IMAP email, and watched folders (local, cloud, FTP/SFTP) +- **Processing Pipelines** — customizable multi-step workflows with conditional routing rules +- **Full-Text Search** — powered by Meilisearch for instant document discovery +- **Multi-User with SSO** — local accounts, OAuth2/OIDC (Authentik), and social login (Google, Microsoft, Apple, Dropbox) -The project includes a **UI** for uploading and managing files, and an API documentation page is available at `/docs` (powered by **FastAPI**). - -## Documentation Index - -- [User Guide](docs/UserGuide.md) - How to use DocuElevate -- [Browser Extension Guide](docs/BrowserExtension.md) - Install and use the browser extension -- [API Documentation](docs/API.md) - API reference -- [Deployment Guide](docs/DeploymentGuide.md) - How to deploy DocuElevate -- [Configuration Guide](docs/ConfigurationGuide.md) - Available configuration options -- [Build Metadata](docs/BuildMetadata.md) - Automated version and build information -- [CI/CD Tools Guide](docs/CIToolsGuide.md) - CI/CD pipeline and tool documentation -- [CI Workflow Guide](docs/CIWorkflow.md) - Detailed workflow documentation -- [Development Guide](CONTRIBUTING.md) - How to contribute to DocuElevate -- [Troubleshooting](docs/Troubleshooting.md) - Common issues and solutions +The project ships with a web UI, a REST + GraphQL API, a CLI tool, a native mobile app (iOS & Android), a browser extension, and Helm charts for Kubernetes deployment. ## Screenshots
- Upload interface for adding new documents
+Upload interface — drag-and-drop file upload with real-time progress
- Files view with processed documents and metadata
+Files view — processed documents with AI-extracted metadata
+ +
+ Status view — system health and service monitoring