Skip to content

Commit c578834

Browse files
committed
📚 docs(readme): add Dummy Payment documentation
Changes made in this commit: - Modified: README.md - Modified: .github/media/banner.png - Modified: .github/media/demo.gif - Modified: .github/media/demo.mp4 Key changes: - Add comprehensive Dummy Payment section with features and use cases - Add section headers for Video Example and Admin Panel Screenshots - Update Free Products section with references to Dummy Payment - Add Dummy Payment checkbox to Roadmap section - Update media files in .github/media directory
1 parent 9e95588 commit c578834

File tree

4 files changed

+33
-4
lines changed

4 files changed

+33
-4
lines changed

.github/media/banner.png

37.5 KB
Loading

.github/media/demo.gif

-250 KB
Loading

.github/media/demo.mp4

2.36 MB
Binary file not shown.

README.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ Litecart is an open source shopping-cart in 1 file of embedded database (SQLite)
1818
> [!WARNING]
1919
> Current major version is zero (`v0.x.x`) to accommodate rapid development and fast iteration while getting early feedback from users. Please keep in mind that litecart is still under active development and therefore full backward compatibility is not guaranteed before reaching v1.0.0.
2020
21+
### Video Example
2122
![Example](https://github.com/shurco/litecart/blob/main/.github/media/demo.gif)
2223

24+
### Admin Panel Screenshots
2325
<p align="center">
2426
<img src="https://github.com/shurco/litecart/blob/main/.github/media/screenshots/products.png" width="270">
2527
<img src="https://github.com/shurco/litecart/blob/main/.github/media/screenshots/product-edit.png" width="270">
@@ -322,6 +324,31 @@ To obtain a "Merchant ID", "Project (API) ID" and "Private key" in <a href="http
322324
> Please note that the "Private key" is confidential information that should be kept secure.
323325
324326

327+
#### Dummy Payment
328+
Dummy Payment is a built-in payment provider that comes pre-configured with litecart. It is designed for processing free products (products with a price of $0) and does not require any external payment system integration or API keys.
329+
330+
**How it works:**
331+
- Automatically activated when a customer's cart contains only free products (total amount = $0)
332+
- No payment processing occurs - orders are immediately marked as paid
333+
- Customers only need to provide their email address to complete the checkout
334+
- Perfect for free downloads, samples, promotional content, and lead generation
335+
336+
**Key features:**
337+
- **No configuration required**: Works out of the box, no setup needed
338+
- **No API keys needed**: Unlike other payment providers, Dummy Payment doesn't require any external accounts or credentials
339+
- **Instant processing**: Orders are processed immediately without waiting for payment confirmation
340+
- **Full feature support**: All standard features work with Dummy Payment, including email delivery, digital file downloads, license keys, and webhooks
341+
342+
**When to use:**
343+
- Selling free products or samples
344+
- Offering promotional content
345+
- Collecting email addresses for lead generation
346+
- Testing the checkout process during development
347+
348+
> [!NOTE]
349+
> Dummy Payment is only used for carts containing exclusively free products. If a cart contains both free and paid products, customers must use a regular payment system (Stripe, PayPal, or SpectroCoin) to complete the purchase.
350+
351+
325352
## 🆓&nbsp;&nbsp;Free Products
326353

327354
Litecart supports free products, allowing you to offer digital content, samples, or promotional materials at no cost to your customers.
@@ -336,10 +363,10 @@ To create a free product:
336363

337364
### How Free Products Work
338365

339-
- **Automatic Processing**: When a customer adds only free products to their cart (total amount = 0), the checkout process automatically uses the built-in dummy payment provider
340-
- **No Payment Required**: Free products bypass all payment system integrations - customers can complete their purchase with just an email address
366+
- **Automatic Processing**: When a customer adds only free products to their cart (total amount = 0), the checkout process automatically uses the built-in **Dummy Payment** provider (see [Dummy Payment](#dummy-payment-built-in) section for details)
367+
- **No Payment Required**: Free products bypass all external payment system integrations - customers can complete their purchase with just an email address
341368
- **Instant Access**: After checkout, customers immediately receive access to free products via email, just like paid products
342-
- **Mixed Carts**: If a cart contains both free and paid products, customers must use a regular payment system to complete the purchase
369+
- **Mixed Carts**: If a cart contains both free and paid products, customers must use a regular payment system (Stripe, PayPal, or SpectroCoin) to complete the purchase
343370

344371
### Use Cases
345372

@@ -353,9 +380,10 @@ Free products are perfect for:
353380
### Technical Details
354381

355382
- Free products are identified by `amount = 0` in the database
356-
- The dummy payment provider is automatically selected for carts with `amountTotal = 0`
383+
- The **Dummy Payment** provider is automatically selected for carts with `amountTotal = 0`
357384
- All standard features work with free products: email delivery, digital file downloads, license keys, and webhooks
358385
- Free products are included in order history and cart management just like paid products
386+
- No external payment processing occurs - orders are immediately marked as paid when using Dummy Payment
359387

360388

361389
## 🧩&nbsp;&nbsp;For developers
@@ -401,6 +429,7 @@ For detailed information on how to customize the site design and deploy it on a
401429
- [ ] Payment via Webhook
402430
- [x] <a href="#spectrocoin">Support for payment using crypto</a>
403431
- [x] Support WebHook (<a href="https://github.com/msalbrain" target="_blank">@nicksnyder</a> in <a href="https://github.com/shurco/litecart/pull/61" target="_blank">#61</a>)
432+
- [x] <a href="#dummy-payment">Dummy Payment</a> (<a href="https://github.com/majiayu000" target="_blank">@majiayu000</a> in <a href="https://github.com/shurco/litecart/pull/261" target="_blank">#261</a>)
404433

405434

406435
## 👍&nbsp;&nbsp;Contribute

0 commit comments

Comments
 (0)