From c832e607be50a1d61e5c54bd3878649d0e435ab6 Mon Sep 17 00:00:00 2001 From: Om Wanere <135044200+omwanere@users.noreply.github.com> Date: Wed, 18 Feb 2026 08:35:02 +0000 Subject: [PATCH 1/2] docs: clarify intended usage and Docker vs Edge guidance --- docs/intended_Usage.md | 56 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/intended_Usage.md diff --git a/docs/intended_Usage.md b/docs/intended_Usage.md new file mode 100644 index 000000000..bbb6b690f --- /dev/null +++ b/docs/intended_Usage.md @@ -0,0 +1,56 @@ +## Intended Usage + +This engine is designed for working with Stripe data **after** events occur. +It focuses on data ingestion, synchronization, and analytics. + +### This engine IS intended for: +- Syncing Stripe data to databases or warehouses +- Processing Stripe webhooks +- Running analytics and reporting +- Building dashboards on Stripe data + +### This engine is NOT intended for: +- Handling Stripe Checkout +- Processing live payments +- Creating or managing sales flows +- Replacing Stripe’s official SDKs + + +## Should I use this engine? + +| Use case | Should I use this? | +|--------|------------------| +| Accept payments | ❌ No | +| Stripe Checkout | ❌ No | +| Subscription creation | ❌ No | +| Sync Stripe data | ✅ Yes | +| Analytics & reporting | ✅ Yes | +| Webhook processing | ✅ Yes | + + +## Docker vs Edge Usage + +### Docker +Use Docker when you need: +- Long-running sync jobs +- Batch processing +- High data volumes +- Stable server environments + +### Edge +Use Edge when you need: +- Low-latency webhook handling +- Lightweight event processing +- Serverless deployments + +⚠️ Edge is not recommended for heavy analytics or long-running jobs. + + +## Example Usage + +If you are starting a new project and want to accept Stripe payments: +- Use Stripe Checkout or Stripe SDKs +- Use this engine only to sync data and run analytics + +If you already accept payments and want reporting or dashboards: +- This engine is an appropriate tool From 8369089b88492c8c633af1192e5923c9a58d238b Mon Sep 17 00:00:00 2001 From: Om Wanere <135044200+omwanere@users.noreply.github.com> Date: Wed, 18 Feb 2026 08:47:43 +0000 Subject: [PATCH 2/2] docs: format intended usage documentation --- docs/{intended_Usage.md => intended-usage.md} | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) rename docs/{intended_Usage.md => intended-usage.md} (75%) diff --git a/docs/intended_Usage.md b/docs/intended-usage.md similarity index 75% rename from docs/intended_Usage.md rename to docs/intended-usage.md index bbb6b690f..b2bf352d4 100644 --- a/docs/intended_Usage.md +++ b/docs/intended-usage.md @@ -4,53 +4,58 @@ This engine is designed for working with Stripe data **after** events occur. It focuses on data ingestion, synchronization, and analytics. ### This engine IS intended for: + - Syncing Stripe data to databases or warehouses - Processing Stripe webhooks - Running analytics and reporting - Building dashboards on Stripe data ### This engine is NOT intended for: + - Handling Stripe Checkout - Processing live payments - Creating or managing sales flows - Replacing Stripe’s official SDKs - ## Should I use this engine? -| Use case | Should I use this? | -|--------|------------------| -| Accept payments | ❌ No | -| Stripe Checkout | ❌ No | -| Subscription creation | ❌ No | -| Sync Stripe data | ✅ Yes | -| Analytics & reporting | ✅ Yes | -| Webhook processing | ✅ Yes | - +| Use case | Should I use this? | +| --------------------- | ------------------ | +| Accept payments | ❌ No | +| Stripe Checkout | ❌ No | +| Subscription creation | ❌ No | +| Sync Stripe data | ✅ Yes | +| Analytics & reporting | ✅ Yes | +| Webhook processing | ✅ Yes | ## Docker vs Edge Usage ### Docker + Use Docker when you need: + - Long-running sync jobs - Batch processing - High data volumes - Stable server environments ### Edge + Use Edge when you need: + - Low-latency webhook handling - Lightweight event processing - Serverless deployments ⚠️ Edge is not recommended for heavy analytics or long-running jobs. - ## Example Usage If you are starting a new project and want to accept Stripe payments: + - Use Stripe Checkout or Stripe SDKs - Use this engine only to sync data and run analytics If you already accept payments and want reporting or dashboards: + - This engine is an appropriate tool