Skip to content

docs: Modernize README with comprehensive documentation#83

Open
jeremiahjordanisaacson wants to merge 1 commit intodavidfowl:mainfrom
jeremiahjordanisaacson:update-readme-modern
Open

docs: Modernize README with comprehensive documentation#83
jeremiahjordanisaacson wants to merge 1 commit intodavidfowl:mainfrom
jeremiahjordanisaacson:update-readme-modern

Conversation

@jeremiahjordanisaacson
Copy link
Copy Markdown

Summary

  • Add centered logo, badges (tests, release, license, Python version)
  • Add navigation links to documentation site
  • Add "Why Tally?" section explaining the value proposition
  • Expand command reference table with all available commands
  • Add step-by-step "How It Works" guide with configuration examples
  • Document complete rule syntax (match functions, conditions, tag-only rules, field transforms)
  • Add special tags reference (income, transfer, investment, refund)
  • Add views/custom report sections documentation
  • Document all output formats (HTML, JSON, CSV, Markdown)
  • Add configuration reference with settings.yaml examples
  • Add amount modifiers reference table
  • Add tips & best practices section
  • Add project structure diagram
  • Add contributing section

Test plan

  • Verify all markdown renders correctly on GitHub
  • Verify badge URLs point to correct workflows/releases
  • Verify documentation links work

🤖 Generated with Claude Code

- Add centered logo, badges (tests, release, license, Python version) - Add navigation links to documentation site - Add "Why Tally?" section explaining the value proposition - Expand command reference table with all available commands - Add step-by-step "How It Works" guide - Document complete rule syntax with examples - Add special tags reference (income, transfer, investment, refund) - Add views/custom report sections documentation - Document all output formats (HTML, JSON, CSV, Markdown) - Add configuration reference with settings.yaml examples - Add amount modifiers reference table - Add tips & best practices section - Add project structure diagram - Improve documentation links section - Add contributing section Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

PR Build Available

Version: 0.0.83-d9f094a

Install from this PR

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/davidfowl/tally/main/docs/install-pr.sh | bash -s -- 83

Windows PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/davidfowl/tally/main/docs/install-pr.ps1) } 83"

Manual download: View workflow run and download artifacts.

Requirements
  • GitHub CLI (gh) must be installed and authenticated
  • Run gh auth login if not already authenticated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant