kreuzberg 4.0.0.rc2 → 4.0.1

data/README.md

@@ -1,426 +1,391 @@
-# Kreuzberg for Ruby
-
-[![RubyGems](https://img.shields.io/gem/v/kreuzberg)](https://rubygems.org/gems/kreuzberg)
-[![Crates.io](https://img.shields.io/crates/v/kreuzberg)](https://crates.io/crates/kreuzberg)
-[![PyPI](https://img.shields.io/pypi/v/kreuzberg)](https://pypi.org/project/kreuzberg/)
-[![npm](https://img.shields.io/npm/v/kreuzberg)](https://www.npmjs.com/package/kreuzberg)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Documentation](https://img.shields.io/badge/docs-kreuzberg.dev-blue)](https://kreuzberg.dev)
-
-High-performance document intelligence for Ruby, powered by Rust.
-
-Extract text, tables, images, and metadata from 30+ file formats including PDF, DOCX, PPTX, XLSX, images, and more.
-
-> **🚀 Version 4.0.0 Release Candidate**
-> This is a pre-release version. We invite you to test the library and [report any issues](https://github.com/kreuzberg-dev/kreuzberg/issues) you encounter.
-
-## Features
-
-- **30+ File Formats**: PDF, DOCX, PPTX, XLSX, images, HTML, Markdown, XML, JSON, and more
-- **OCR Support**: Built-in Tesseract OCR for scanned documents and images
-- **High Performance**: Rust-powered extraction for native-level performance
-- **Table Extraction**: Extract structured tables from documents
-- **Language Detection**: Automatic language detection for extracted text
-- **Text Chunking**: Split long documents into manageable chunks
-- **Caching**: Built-in result caching for faster repeated extractions
-- **Type-Safe**: Comprehensive typed configuration and result objects
-
-## Requirements
-
-- Ruby 3.2 or higher
-- Rust toolchain (for building from source)
-
-### Optional System Dependencies
-
-- **Tesseract**: For OCR functionality
-  - macOS: `brew install tesseract`
-  - Ubuntu: `sudo apt-get install tesseract-ocr`
-  - Windows: Download from [GitHub](https://github.com/tesseract-ocr/tesseract)
-
-- **LibreOffice**: For legacy MS Office formats (.doc, .ppt)
-  - macOS: `brew install libreoffice`
-  - Ubuntu: `sudo apt-get install libreoffice`
-
-- **Pandoc**: For advanced document conversion
-  - macOS: `brew install pandoc`
-  - Ubuntu: `sudo apt-get install pandoc`
-
-## Installation
-
-Add to your Gemfile:
-
-```ruby
-gem 'kreuzberg'
-```
-
-Then run:
-
-```bash
-bundle install
-```
-
-Or install directly:
-
-```bash
-gem install kreuzberg
-```
-
-## Quick Start
-
-### Basic Extraction
-
-```ruby
-require 'kreuzberg'
-
-# Extract from a file
-result = Kreuzberg.extract_file_sync("document.pdf")
-puts result.content
-puts "MIME type: #{result.mime_type}"
-```
-
-### With Configuration
-
-```ruby
-# Create configuration
-config = Kreuzberg::Config::Extraction.new(
-  use_cache: true,
-  force_ocr: false
-)
-
-result = Kreuzberg.extract_file_sync("document.pdf", config: config)
-```
-
-### With OCR
-
-```ruby
-# Configure OCR
-ocr_config = Kreuzberg::Config::OCR.new(
-  backend: "tesseract",
-  language: "eng",
-  preprocessing: true
-)
-
-config = Kreuzberg::Config::Extraction.new(ocr: ocr_config)
-result = Kreuzberg.extract_file_sync("scanned.pdf", config: config)
-```
-
-### Extract from Bytes
-
-```ruby
-data = File.binread("document.pdf")
-result = Kreuzberg.extract_bytes_sync(data, "application/pdf")
-puts result.content
-```
-
-### Batch Processing
-
-```ruby
-paths = ["doc1.pdf", "doc2.docx", "doc3.xlsx"]
-results = Kreuzberg.batch_extract_files_sync(paths)
-
-results.each do |result|
-  puts "Content: #{result.content[0..100]}"
-  puts "MIME: #{result.mime_type}"
-end
-```
-
-### Structured Results (Chunks & Images)
-
-```ruby
-result = Kreuzberg.extract_file_sync("long-report.pdf", config: {
-  chunking: { max_chars: 750 },
-  image_extraction: { extract_images: true }
-})
-
-result.chunks&.each do |chunk|
-  puts "[#{chunk.chunk_index + 1}/#{chunk.total_chunks}] #{chunk.content[0..80]}"
-end
-
-result.images&.each do |image|
-  File.binwrite("image-#{image.image_index}.#{image.format}", image.data)
-  if image.ocr_result
-    puts "Embedded OCR content: #{image.ocr_result.content[0..60]}"
-  end
-end
-```
-
-## Configuration
-
-### Load From File
-
-```ruby
-config = Kreuzberg::Config::Extraction.from_file("config.toml")
-result = Kreuzberg.extract_file_sync("report.pdf", config: config)
-```
-
-### Extraction Configuration
-
-```ruby
-config = Kreuzberg::Config::Extraction.new(
-  use_cache: true,                      # Enable result caching
-  enable_quality_processing: false,     # Enable text quality processing
-  force_ocr: false                      # Force OCR even for digital PDFs
-)
-```
-
-### OCR Configuration
-
-```ruby
-ocr = Kreuzberg::Config::OCR.new(
-  backend: "tesseract",           # OCR backend (tesseract, easyocr, paddleocr)
-  language: "eng",                # Language code (eng, deu, fra, etc.)
-  tesseract_config: {
-    psm: 6,
-    enable_table_detection: true,
-    preprocessing: Kreuzberg::Config::ImagePreprocessing.new(auto_rotate: true).to_h
-  }
-)
-
-config = Kreuzberg::Config::Extraction.new(ocr: ocr)
-```
-
-### Chunking Configuration
-
-```ruby
-chunking = Kreuzberg::Config::Chunking.new(
-  enabled: true,
-  chunk_size: 1000,       # Characters per chunk
-  chunk_overlap: 200,     # Overlap between chunks
-  embedding: {
-    model: { type: :preset, name: "balanced" },
-    normalize: true
-  }
-)
-
-config = Kreuzberg::Config::Extraction.new(chunking: chunking)
-result = Kreuzberg.extract_file_sync("long_document.pdf", config: config)
-
-result.chunks.each do |chunk|
-  puts "Chunk: #{chunk.content}"
-  puts "Tokens: #{chunk.token_count}"
-end
-```
-
-### HTML Conversion Options
-
-```ruby
-html_options = Kreuzberg::Config::HtmlOptions.new(
-  heading_style: :atx_closed,
-  wrap: true,
-  wrap_width: 100,
-  preprocessing: { enabled: true, preset: :standard }
-)
-
-config = Kreuzberg::Config::Extraction.new(html_options: html_options)
-result = Kreuzberg.extract_file_sync("page.html", config: config)
-```
-
-### Keyword Extraction
-
-```ruby
-keywords = Kreuzberg::Config::Keywords.new(
-  algorithm: :yake,
-  max_keywords: 8,
-  min_score: 0.2,
-  ngram_range: [1, 3]
-)
-
-config = Kreuzberg::Config::Extraction.new(keywords: keywords)
-result = Kreuzberg.extract_file_sync("research.pdf", config: config)
-```
-
-### Language Detection
-
-```ruby
-lang_detection = Kreuzberg::Config::LanguageDetection.new(
-  enabled: true,
-  min_confidence: 0.8,
-  detect_multiple: true
-)
-
-config = Kreuzberg::Config::Extraction.new(language_detection: lang_detection)
-result = Kreuzberg.extract_file_sync("multilingual.pdf", config: config)
-
-result.detected_languages&.each do |lang|
-  puts "Language: #{lang.lang}, Confidence: #{lang.confidence}"
-end
-```
-
-### PDF Options
-
-```ruby
-pdf_options = Kreuzberg::Config::PDF.new(
-  extract_images: true,
-  image_min_size: 10000,    # Minimum image size in bytes
-  password: "secret"        # PDF password
-)
-
-config = Kreuzberg::Config::Extraction.new(pdf_options: pdf_options)
-```
-
-## Working with Results
-
-```ruby
-result = Kreuzberg.extract_file_sync("invoice.pdf")
-
-# Access extracted text
-puts result.content
-
-# Access MIME type
-puts result.mime_type
-
-# Access metadata
-puts result.metadata.inspect
-
-# Access extracted tables
-result.tables.each do |table|
-  puts "Headers: #{table.headers.join(', ')}"
-  table.rows.each do |row|
-    puts row.join(', ')
-  end
-end
-
-# Access text chunks and metadata
-result.chunks&.each do |chunk|
-  puts "Chunk #{chunk.chunk_index + 1}/#{chunk.total_chunks}"
-  puts "Chars: #{chunk.char_start}-#{chunk.char_end}"
-  puts "Embedding length: #{chunk.embedding&.length}"
-end
-
-# Access extracted images
-result.images&.each do |image|
-  File.binwrite("image-\#{image.image_index}.#{image.format}", image.data)
-  puts "Image #{image.image_index} on page #{image.page_number}"
-end
-
-# Convert to hash
-hash = result.to_h
-
-# Convert to JSON
-json = result.to_json
-```
-
-## CLI Usage
-
-Kreuzberg provides a Ruby wrapper for the CLI:
-
-```ruby
-# Extract content
-output = Kreuzberg::CLI.extract("document.pdf", output: "text")
-
-# Detect MIME type
-mime_type = Kreuzberg::CLI.detect("document.pdf")
-
-# Get version
-version = Kreuzberg::CLI.version
-```
-
-## API Server
-
-Start an API server (requires kreuzberg CLI):
-
-```ruby
-Kreuzberg::APIProxy.run(port: 8000) do |server|
-  # Server runs in background
-  # Make HTTP requests to http://localhost:8000
-end
-```
-
-## MCP Server
-
-Start a Model Context Protocol server for Claude Desktop:
-
-```ruby
-server = Kreuzberg::MCPProxy::Server.new(transport: 'stdio')
-server.start
-
-# Use with Claude Desktop integration
-```
-
-## Cache Management
-
-```ruby
-# Get cache statistics
-stats = Kreuzberg.cache_stats
-puts "Entries: #{stats[:total_entries]}"
-puts "Size: #{stats[:total_size_bytes]} bytes"
-
-# Clear cache
-Kreuzberg.clear_cache
-```
-
-## Error Handling
-
-```ruby
-begin
-  result = Kreuzberg.extract_file_sync("document.pdf")
-rescue Kreuzberg::Errors::ParsingError => e
-  puts "Parsing failed: #{e.message}"
-  puts "Context: #{e.context}"
-rescue Kreuzberg::Errors::OCRError => e
-  puts "OCR failed: #{e.message}"
-rescue Kreuzberg::Errors::MissingDependencyError => e
-  puts "Missing dependency: #{e.dependency}"
-rescue Kreuzberg::Errors::Error => e
-  puts "Kreuzberg error: #{e.message}"
-end
-```
-
-## Supported Formats
-
-- **Documents**: PDF, DOCX, DOC, PPTX, PPT, ODT, ODP
-- **Spreadsheets**: XLSX, XLS, ODS, CSV
-- **Images**: PNG, JPEG, TIFF, BMP, GIF
-- **Web**: HTML, MHTML, Markdown
-- **Data**: JSON, YAML, TOML, XML
-- **Email**: EML, MSG
-- **Archives**: ZIP, TAR, 7Z
-- **Text**: TXT, RTF, MD
-
-## Performance
-
-Kreuzberg's Rust core provides significant performance improvements:
-
-- **PDF extraction**: 10-50x faster than pure Ruby solutions
-- **Batch processing**: Parallel extraction with Tokio async runtime
-- **Memory efficient**: Streaming parsers for large files
-- **Caching**: Automatic result caching for repeated extractions
-
-## Development
-
-```bash
-# Clone the repository
-git clone https://github.com/kreuzberg-dev/kreuzberg.git
-cd kreuzberg/packages/ruby
-
-# Install dependencies
-bundle install
-
-# Set up vendor symlink for local development (required for building)
-ln -sfn ../../crates/kreuzberg vendor/kreuzberg
-
-# Build the Rust extension
-bundle exec rake compile
-
-# Run tests
-bundle exec rspec
-
-# Run RuboCop
-bundle exec rubocop
-```
-
-**Note**: The Ruby bindings use a vendored copy of the core `kreuzberg` Rust crate. For local development, create a symlink at `vendor/kreuzberg` pointing to `../../crates/kreuzberg`. In CI and gem packaging, the actual vendored files are copied to this location.
-
-## License
-
-MIT License. See [LICENSE](../../LICENSE) for details.
-
-## Contributing
-
-Contributions are welcome! Please see [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines.
-
-## Links
-
-- **Documentation**: https://docs.kreuzberg.dev
-- **GitHub**: https://github.com/kreuzberg-dev/kreuzberg
-- **Issues**: https://github.com/kreuzberg-dev/kreuzberg/issues
+# Ruby
+
+<div align="center" style="display: flex; flex-wrap: wrap; gap: 8px; justify-content: center; margin: 20px 0;">
+  <!-- Language Bindings -->
+  <a href="https://crates.io/crates/kreuzberg">
+    <img src="https://img.shields.io/crates/v/kreuzberg?label=Rust&color=007ec6" alt="Rust">
+  </a>
+  <a href="https://hex.pm/packages/kreuzberg">
+    <img src="https://img.shields.io/hexpm/v/kreuzberg?label=Elixir&color=007ec6" alt="Elixir">
+  </a>
+  <a href="https://pypi.org/project/kreuzberg/">
+    <img src="https://img.shields.io/pypi/v/kreuzberg?label=Python&color=007ec6" alt="Python">
+  </a>
+  <a href="https://www.npmjs.com/package/@kreuzberg/node">
+    <img src="https://img.shields.io/npm/v/@kreuzberg/node?label=Node.js&color=007ec6" alt="Node.js">
+  </a>
+  <a href="https://www.npmjs.com/package/@kreuzberg/wasm">
+    <img src="https://img.shields.io/npm/v/@kreuzberg/wasm?label=WASM&color=007ec6" alt="WASM">
+  </a>
+
+  <a href="https://central.sonatype.com/artifact/dev.kreuzberg/kreuzberg">
+    <img src="https://img.shields.io/maven-central/v/dev.kreuzberg/kreuzberg?label=Java&color=007ec6" alt="Java">
+  </a>
+  <a href="https://github.com/kreuzberg-dev/kreuzberg/releases">
+    <img src="https://img.shields.io/github/v/tag/kreuzberg-dev/kreuzberg?label=Go&color=007ec6&filter=v4.0.0" alt="Go">
+  </a>
+  <a href="https://www.nuget.org/packages/Kreuzberg/">
+    <img src="https://img.shields.io/nuget/v/Kreuzberg?label=C%23&color=007ec6" alt="C#">
+  </a>
+  <a href="https://packagist.org/packages/kreuzberg/kreuzberg">
+    <img src="https://img.shields.io/packagist/v/kreuzberg/kreuzberg?label=PHP&color=007ec6" alt="PHP">
+  </a>
+  <a href="https://rubygems.org/gems/kreuzberg">
+    <img src="https://img.shields.io/gem/v/kreuzberg?label=Ruby&color=007ec6" alt="Ruby">
+  </a>
+
+  <!-- Project Info -->
+  <a href="https://github.com/kreuzberg-dev/kreuzberg/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+  </a>
+  <a href="https://docs.kreuzberg.dev">
+    <img src="https://img.shields.io/badge/docs-kreuzberg.dev-blue" alt="Documentation">
+  </a>
+</div>
+
+<img width="1128" height="191" alt="Banner2" src="https://github.com/user-attachments/assets/419fc06c-8313-4324-b159-4b4d3cfce5c0" />
+
+<div align="center" style="margin-top: 20px;">
+  <a href="https://discord.gg/pXxagNK2zN">
+      <img height="22" src="https://img.shields.io/badge/Discord-Join%20our%20community-7289da?logo=discord&logoColor=white" alt="Discord">
+  </a>
+</div>
+
+
+Extract text, tables, images, and metadata from 56 file formats including PDF, Office documents, and images. Ruby bindings with idiomatic Ruby API and native performance.
+
+
+## Installation
+
+### Package Installation
+
+
+Install via one of the supported package managers:
+
+
+
+**gem:**
+```bash
+gem install kreuzberg
+```
+
+
+
+
+**Bundler:**
+```ruby
+gem 'kreuzberg'
+```
+
+
+
+
+
+### System Requirements
+
+- **Ruby 2.7+** required
+- Optional: [ONNX Runtime](https://github.com/microsoft/onnxruntime/releases) version 1.22.x for embeddings support
+- Optional: [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) for OCR functionality
+
+
+
+## Quick Start
+
+### Basic Extraction
+
+Extract text, metadata, and structure from any supported document format:
+
+```ruby
+require 'kreuzberg'
+
+result = Kreuzberg.extract_file_sync('document.pdf')
+
+puts "Content:"
+puts result.content
+
+puts "\nMetadata:"
+puts "Title: #{result.metadata&.dig('title')}"
+puts "Author: #{result.metadata&.dig('author')}"
+
+puts "\nTables found: #{result.tables.length}"
+puts "Images found: #{result.images.length}"
+```
+
+
+### Common Use Cases
+
+#### Extract with Custom Configuration
+
+Most use cases benefit from configuration to control extraction behavior:
+
+
+**With OCR (for scanned documents):**
+
+```ruby
+require 'kreuzberg'
+
+ocr_config = Kreuzberg::Config::OCR.new(
+  backend: 'tesseract',
+  language: 'eng'
+)
+
+config = Kreuzberg::Config::Extraction.new(ocr: ocr_config)
+result = Kreuzberg.extract_file_sync('scanned.pdf', config: config)
+
+puts "Extracted text from scanned document:"
+puts result.content
+puts "Used OCR backend: tesseract"
+```
+
+
+
+
+#### Table Extraction
+
+
+See [Table Extraction Guide](https://kreuzberg.dev/features/table-extraction/) for detailed examples.
+
+
+
+#### Processing Multiple Files
+
+
+```ruby
+require 'kreuzberg'
+
+puts "Kreuzberg version: #{Kreuzberg::VERSION}"
+puts "FFI bindings loaded successfully"
+
+result = Kreuzberg.extract_file_sync('sample.pdf')
+puts "Installation verified! Extracted #{result.content.length} characters"
+```
+
+
+
+
+
+#### Async Processing
+
+For non-blocking document processing:
+
+```ruby
+require 'kreuzberg'
+
+config = Kreuzberg::Config::Extraction.new(
+  use_cache: true,
+  enable_quality_processing: true
+)
+
+result = Kreuzberg.extract_file_sync('contract.pdf', config: config)
+
+puts "Extracted #{result.content.length} characters"
+puts "Quality score: #{result.metadata&.dig('quality_score')}"
+puts "Processing time: #{result.metadata&.dig('processing_time')}ms"
+```
+
+
+
+
+
+
+### Next Steps
+
+- **[Installation Guide](https://kreuzberg.dev/getting-started/installation/)** - Platform-specific setup
+- **[API Documentation](https://kreuzberg.dev/api/)** - Complete API reference
+- **[Examples & Guides](https://kreuzberg.dev/guides/)** - Full code examples and usage guides
+- **[Configuration Guide](https://kreuzberg.dev/guides/configuration/)** - Advanced configuration options
+
+
+
+## Features
+
+### Supported File Formats (56+)
+
+56 file formats across 8 major categories with intelligent format detection and comprehensive metadata extraction.
+
+#### Office Documents
+
+| Category | Formats | Capabilities |
+|----------|---------|--------------|
+| **Word Processing** | `.docx`, `.odt` | Full text, tables, images, metadata, styles |
+| **Spreadsheets** | `.xlsx`, `.xlsm`, `.xlsb`, `.xls`, `.xla`, `.xlam`, `.xltm`, `.ods` | Sheet data, formulas, cell metadata, charts |
+| **Presentations** | `.pptx`, `.ppt`, `.ppsx` | Slides, speaker notes, images, metadata |
+| **PDF** | `.pdf` | Text, tables, images, metadata, OCR support |
+| **eBooks** | `.epub`, `.fb2` | Chapters, metadata, embedded resources |
+
+#### Images (OCR-Enabled)
+
+| Category | Formats | Features |
+|----------|---------|----------|
+| **Raster** | `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.bmp`, `.tiff`, `.tif` | OCR, table detection, EXIF metadata, dimensions, color space |
+| **Advanced** | `.jp2`, `.jpx`, `.jpm`, `.mj2`, `.pnm`, `.pbm`, `.pgm`, `.ppm` | OCR, table detection, format-specific metadata |
+| **Vector** | `.svg` | DOM parsing, embedded text, graphics metadata |
+
+#### Web & Data
+
+| Category | Formats | Features |
+|----------|---------|----------|
+| **Markup** | `.html`, `.htm`, `.xhtml`, `.xml`, `.svg` | DOM parsing, metadata (Open Graph, Twitter Card), link extraction |
+| **Structured Data** | `.json`, `.yaml`, `.yml`, `.toml`, `.csv`, `.tsv` | Schema detection, nested structures, validation |
+| **Text & Markdown** | `.txt`, `.md`, `.markdown`, `.rst`, `.org`, `.rtf` | CommonMark, GFM, reStructuredText, Org Mode |
+
+#### Email & Archives
+
+| Category | Formats | Features |
+|----------|---------|----------|
+| **Email** | `.eml`, `.msg` | Headers, body (HTML/plain), attachments, threading |
+| **Archives** | `.zip`, `.tar`, `.tgz`, `.gz`, `.7z` | File listing, nested archives, metadata |
+
+#### Academic & Scientific
+
+| Category | Formats | Features |
+|----------|---------|----------|
+| **Citations** | `.bib`, `.biblatex`, `.ris`, `.enw`, `.csl` | Bibliography parsing, citation extraction |
+| **Scientific** | `.tex`, `.latex`, `.typst`, `.jats`, `.ipynb`, `.docbook` | LaTeX, Jupyter notebooks, PubMed JATS |
+| **Documentation** | `.opml`, `.pod`, `.mdoc`, `.troff` | Technical documentation formats |
+
+**[Complete Format Reference](https://kreuzberg.dev/reference/formats/)**
+
+### Key Capabilities
+
+- **Text Extraction** - Extract all text content with position and formatting information
+- **Metadata Extraction** - Retrieve document properties, creation date, author, etc.
+- **Table Extraction** - Parse tables with structure and cell content preservation
+- **Image Extraction** - Extract embedded images and render page previews
+- **OCR Support** - Integrate multiple OCR backends for scanned documents
+
+- **Async/Await** - Non-blocking document processing with concurrent operations
+
+
+- **Plugin System** - Extensible post-processing for custom text transformation
+
+
+- **Embeddings** - Generate vector embeddings using ONNX Runtime models
+
+- **Batch Processing** - Efficiently process multiple documents in parallel
+- **Memory Efficient** - Stream large files without loading entirely into memory
+- **Language Detection** - Detect and support multiple languages in documents
+- **Configuration** - Fine-grained control over extraction behavior
+
+### Performance Characteristics
+
+| Format | Speed | Memory | Notes |
+|--------|-------|--------|-------|
+| **PDF (text)** | 10-100 MB/s | ~50MB per doc | Fastest extraction |
+| **Office docs** | 20-200 MB/s | ~100MB per doc | DOCX, XLSX, PPTX |
+| **Images (OCR)** | 1-5 MB/s | Variable | Depends on OCR backend |
+| **Archives** | 5-50 MB/s | ~200MB per doc | ZIP, TAR, etc. |
+| **Web formats** | 50-200 MB/s | Streaming | HTML, XML, JSON |
+
+
+
+## OCR Support
+
+Kreuzberg supports multiple OCR backends for extracting text from scanned documents and images:
+
+
+- **Tesseract**
+
+
+### OCR Configuration Example
+
+```ruby
+require 'kreuzberg'
+
+ocr_config = Kreuzberg::Config::OCR.new(
+  backend: 'tesseract',
+  language: 'eng'
+)
+
+config = Kreuzberg::Config::Extraction.new(ocr: ocr_config)
+result = Kreuzberg.extract_file_sync('scanned.pdf', config: config)
+
+puts "Extracted text from scanned document:"
+puts result.content
+puts "Used OCR backend: tesseract"
+```
+
+
+
+
+## Async Support
+
+This binding provides full async/await support for non-blocking document processing:
+
+```ruby
+require 'kreuzberg'
+
+config = Kreuzberg::Config::Extraction.new(
+  use_cache: true,
+  enable_quality_processing: true
+)
+
+result = Kreuzberg.extract_file_sync('contract.pdf', config: config)
+
+puts "Extracted #{result.content.length} characters"
+puts "Quality score: #{result.metadata&.dig('quality_score')}"
+puts "Processing time: #{result.metadata&.dig('processing_time')}ms"
+```
+
+
+
+
+## Plugin System
+
+Kreuzberg supports extensible post-processing plugins for custom text transformation and filtering.
+
+For detailed plugin documentation, visit [Plugin System Guide](https://kreuzberg.dev/guides/plugins/).
+
+
+
+
+## Embeddings Support
+
+Generate vector embeddings for extracted text using the built-in ONNX Runtime support. Requires ONNX Runtime installation.
+
+**[Embeddings Guide](https://kreuzberg.dev/features/#embeddings)**
+
+
+
+## Batch Processing
+
+Process multiple documents efficiently:
+
+```ruby
+require 'kreuzberg'
+
+puts "Kreuzberg version: #{Kreuzberg::VERSION}"
+puts "FFI bindings loaded successfully"
+
+result = Kreuzberg.extract_file_sync('sample.pdf')
+puts "Installation verified! Extracted #{result.content.length} characters"
+```
+
+
+
+
+## Configuration
+
+For advanced configuration options including language detection, table extraction, OCR settings, and more:
+
+**[Configuration Guide](https://kreuzberg.dev/guides/configuration/)**
+
+## Documentation
+
+- **[Official Documentation](https://kreuzberg.dev/)**
+- **[API Reference](https://kreuzberg.dev/reference/api-ruby/)**
+- **[Examples & Guides](https://kreuzberg.dev/guides/)**
+
+## Contributing
+
+Contributions are welcome! See [Contributing Guide](https://github.com/kreuzberg-dev/kreuzberg/blob/main/CONTRIBUTING.md).
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+- **Discord Community**: [Join our Discord](https://discord.gg/pXxagNK2zN)
+- **GitHub Issues**: [Report bugs](https://github.com/kreuzberg-dev/kreuzberg/issues)
+- **Discussions**: [Ask questions](https://github.com/kreuzberg-dev/kreuzberg/discussions)