📝 docs(readme): improve library and CLI documentation

- enhance documentation for library and CLI tools, providing comprehensive guides
- include installation, quick start, core types, config, error handling, async runtime
- add gmail query syntax, performance details, logging, security, and troubleshooting
- provide detailed command references, examples, workflows, safety features, and debugging
- update readme headers to reflect new doc structure
This commit is contained in:
Jeremiah Russell
2025-10-17 16:51:05 +01:00
committed by Jeremiah Russell
parent 2cace859ca
commit a5ea370af2
3 changed files with 906 additions and 22 deletions

View File

@@ -31,7 +31,10 @@ The `cull-gmail` provides a software library and command line program to enable
## Main Features
- login to get authorization
- backup the mailbox
- filtered lists of the contents
- move email matching a filtered list to trash
- list labels and messages to aid planning rules
- configure the rules list
- run the rules list
- run the rules list be default
- configure api client by file or environment variables