Skip to content

Update README to reflect current functionality#61

Open
conatus wants to merge 1 commit intomasterfrom
docs/update-readme
Open

Update README to reflect current functionality#61
conatus wants to merge 1 commit intomasterfrom
docs/update-readme

Conversation

@conatus
Copy link
Member

@conatus conatus commented Mar 25, 2026

Summary

  • The README had drifted significantly from the codebase — it referenced Chargebee as the sole payment provider and omitted most current features.
  • Documents all three payment providers: Stripe (subscriptions + one-off donations), GoCardless (Direct Debit), and Chargebee.
  • Adds supporter/donation mode, update flow mode, and membership lapsing/unlapsing.
  • Documents all integrations: Auth0, Zetkin, Action Network, Mailchimp, Sentry, Google Cloud Logging, Microsoft Teams.
  • Expands developer hooks section with all filters and actions.
  • Adds a full configuration reference for frontend and backend environment variables.
  • Updates tech stack, testing, and developer quickstart sections.

- Document Stripe, GoCardless, and Chargebee payment providers
- Add supporter/donation mode and update flow mode
- Document all integrations: Auth0, Zetkin, Action Network, Mailchimp
- Expand developer hooks (filters + actions) section
- Add full configuration reference for frontend and backend env vars
- Add membership lapsing/unlapsing section
- Document membership plans JSON format
- Update tech stack, testing, and quickstart sections
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant