Update package-documentation with the examples

ballerina-platform · Jul 26, 2024 · 1fcbfd3 · 1fcbfd3
1 parent b412ca7
commit 1fcbfd3
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -89,6 +89,15 @@ stripe:Customer customerDetails = check stripe->/customers.post(newCustomer);
 stripe:CustomerResourceCustomerList availableCustomers = check stripe->/customers;
 ```
 
+## Examples
+
+The `ballerinax/stripe` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples), covering various Stripe functionalities.
+
+1. [Manage stripe payments](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples/manage-payments) - Manage business payments with Stripe.
+
+2. [Manage one-time charges](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples/manage-one-time-charges) - Manage business one-time charges with Stripe.
+
+
 ## Build from the source
 
 ### Setting up the prerequisites

diff --git a/ballerina/Module.md b/ballerina/Module.md
@@ -82,3 +82,11 @@ stripe:Customer customerDetails = check stripe->/customers.post(newCustomer);
 ```ballerina
 stripe:CustomerResourceCustomerList availableCustomers = check stripe->/customers;
 ```
+
+## Examples
+
+The `ballerinax/stripe` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples), covering various Stripe functionalities.
+
+1. [Manage stripe payments](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples/manage-payments) - Manage business payments with Stripe.
+
+2. [Manage one-time charges](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples/manage-one-time-charges) - Manage business one-time charges with Stripe.
diff --git a/ballerina/Package.md b/ballerina/Package.md
@@ -82,3 +82,11 @@ stripe:Customer customerDetails = check stripe->/customers.post(newCustomer);
 ```ballerina
 stripe:CustomerResourceCustomerList availableCustomers = check stripe->/customers;
 ```
+
+## Examples
+
+The `ballerinax/stripe` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples), covering various Stripe functionalities.
+
+1. [Manage stripe payments](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples/manage-payments) - Manage business payments with Stripe.
+
+2. [Manage one-time charges](https://github.com/ballerina-platform/module-ballerinax-stripe/tree/main/examples/manage-one-time-charges) - Manage business one-time charges with Stripe.