ppreeper/wkhtmltopdf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

14. README and installation documentation #16

New issue
Closed
opened 2026-05-20 15:32:15 -06:00 by ppreeper · 0 comments
ppreeper commented 2026-05-20 15:32:15 -06:00
Owner
Copy link

Description

Write comprehensive README and usage documentation.

Tasks

  • Update README.md with:
    • Project description
    • Installation instructions
    • Usage examples
    • Supported flags table
    • Environment variables
    • Config file format
    • Exit codes
    • Chrome installation reference (link to INSTALL-chrome-headless.md)
    • Odoo integration guide
  • Include --help output in README
  • Add quick-start example for Odoo replacement

Acceptance Criteria

  • README covers all features and usage patterns
  • Odoo admin can follow README to replace wkhtmltopdf in 5 minutes
  • All supported flags documented with examples
  • Exit codes documented
  • Links to Chrome installation guide

Notes

  • Relates to PRD #2
## Description Write comprehensive README and usage documentation. ## Tasks - [ ] Update `README.md` with: - Project description - Installation instructions - Usage examples - Supported flags table - Environment variables - Config file format - Exit codes - Chrome installation reference (link to `INSTALL-chrome-headless.md`) - Odoo integration guide - [ ] Include `--help` output in README - [ ] Add quick-start example for Odoo replacement ## Acceptance Criteria - README covers all features and usage patterns - Odoo admin can follow README to replace wkhtmltopdf in 5 minutes - All supported flags documented with examples - Exit codes documented - Links to Chrome installation guide ## Notes - Relates to PRD #2
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ppreeper/wkhtmltopdf#16
No description provided.