Add setup and quickstart guide to the package documentation

README.md

@@ -6,9 +6,88 @@
 [![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerinax-stripe.svg)](https://github.com/ballerina-platform/module-ballerinax-stripe/commits/master)
 [![GitHub Issues](https://img.shields.io/github/issues/ballerina-platform/ballerina-library/module/stripe.svg?label=Open%20Issues)](https://github.com/ballerina-platform/ballerina-library/labels/module%stripe)
 
-Stripe offers payment processing software and application programming interfaces for e-commerce websites and mobile applications.
+[Stripe](https://stripe.com/) is a leading online payment processing platform that simplifies the handling of financial transactions over the Internet. Stripe is renowned for its ease of integration, comprehensive documentation, and robust API that supports a wide range of payment operations including credit card transactions, subscription management, and direct payouts to user bank accounts.
 
-The Stripe API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
+The Ballerina Stripe Connector allows developers to interact with the [Stripe REST API V1](https://stripe.com/docs/api), enabling seamless integration of Stripe’s extensive payment processing capabilities into Ballerina applications. This connector facilitates the automation of various payment-related operations such as charge creation, customer management, billing, and direct payouts. By leveraging the Ballerina Stripe Connector, developers can build secure and scalable payment solutions that enhance the e-commerce capabilities of their applications.
+
+## Setup guide
+
+To use the Ballerina Stripe connector, you must have a Stripe account and an API token for authentication. Follow the steps below to set up the connector with your Stripe account. If you don't have an account, you can create one by visiting [Stripe Sign Up page](https://dashboard.stripe.com/register) and completing the registration process.
+
+### Step 1: Log in to Stripe
+
+1. Sign in to your [Stripe dashboard](https://dashboard.stripe.com/login).
+
+### Step 2: Go to the developer portal
+
+1. Click on the **Developers** button in the top-right corner.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-dashboard.png alt="Stripe dashboard" style="width: 70%;">   
+
+### Step 3: Retrieve the secret key
+
+1. Go to **API keys** section in the nav-bar.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-developer-portal.png alt="Stripe dashboard" style="width: 70%;">   
+
+2. Retrieve the **Secret key**.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-api-keys.png alt="Stripe dashboard" style="width: 70%;">   
+
+> **Note:** If you need to have more granular permissions for the keys, you could setup and use `Restricted keys`.
+
+## Quickstart
+
+To begin using the `Stripe` connector in your Ballerina application, you'll need to follow these steps:
+
+### Step 1: Import the connector
+
+First, import the `ballerinax/stripe` package into your Ballerina project.
+
+```ballerina
+import ballerinax/stripe;
+```
+
+### Step 2: Instantiate a new connector
+
+Create a `stripe:ConnectionConfig` object with API token, and initialize the connector.
+
+```ballerina
+configurable string secretKey = ?;
+
+stripe:ConnectionConfig configuration = {
+    auth: {
+        token: secretKey
+    }
+};
+
+stripe:Client stripe = check new (configuration);
+```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+#### Create a new customer
+
+```ballerina
+stripe:v1_customers_body newCustomer = {
+    name: "John Doe",
+    email: "[email protected]",
+    address: {
+        city: "Colombo",
+        country: "Sri Lanka"
+    }
+};
+
+stripe:Customer customerDetails = check stripe->/v1/customers.post(newCustomer);
+```
+
+#### List all customers
+
+```ballerina
+stripe:CustomerResourceCustomerList availableCustomers = check stripe->/v1/customers();
+```
 
 ## Build from the source
 

ballerina/Module.md

@@ -0,0 +1,84 @@
+## Overview
+
+[Stripe](https://stripe.com/) is a leading online payment processing platform that simplifies the handling of financial transactions over the Internet. Stripe is renowned for its ease of integration, comprehensive documentation, and robust API that supports a wide range of payment operations including credit card transactions, subscription management, and direct payouts to user bank accounts.
+
+The Ballerina Stripe Connector allows developers to interact with the [Stripe REST API V1](https://stripe.com/docs/api), enabling seamless integration of Stripe’s extensive payment processing capabilities into Ballerina applications. This connector facilitates the automation of various payment-related operations such as charge creation, customer management, billing, and direct payouts. By leveraging the Ballerina Stripe Connector, developers can build secure and scalable payment solutions that enhance the e-commerce capabilities of their applications.
+
+## Setup guide
+
+To use the Ballerina Stripe connector, you must have a Stripe account and an API token for authentication. Follow the steps below to set up the connector with your Stripe account. If you don't have an account, you can create one by visiting [Stripe Sign Up page](https://dashboard.stripe.com/register) and completing the registration process.
+
+### Step 1: Log in to Stripe
+
+1. Sign in to your [Stripe dashboard](https://dashboard.stripe.com/login).
+
+### Step 2: Go to the developer portal
+
+1. Click on the **Developers** button in the top-right corner.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-dashboard.png alt="Stripe dashboard" style="width: 70%;">   
+
+### Step 3: Retrieve the secret key
+
+1. Go to **API keys** section in the nav-bar.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-developer-portal.png alt="Stripe dashboard" style="width: 70%;">   
+
+2. Retrieve the **Secret key**.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-api-keys.png alt="Stripe dashboard" style="width: 70%;">   
+
+> **Note:** If you need to have more granular permissions for the keys, you could setup and use `Restricted keys`.
+
+## Quickstart
+
+To begin using the `Stripe` connector in your Ballerina application, you'll need to follow these steps:
+
+### Step 1: Import the connector
+
+First, import the `ballerinax/stripe` package into your Ballerina project.
+
+```ballerina
+import ballerinax/stripe;
+```
+
+### Step 2: Instantiate a new connector
+
+Create a `stripe:ConnectionConfig` object with API token, and initialize the connector.
+
+```ballerina
+configurable string secretKey = ?;
+
+stripe:ConnectionConfig configuration = {
+    auth: {
+        token: secretKey
+    }
+};
+
+stripe:Client stripe = check new (configuration);
+```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+#### Create a new customer
+
+```ballerina
+stripe:v1_customers_body newCustomer = {
+    name: "John Doe",
+    email: "[email protected]",
+    address: {
+        city: "Colombo",
+        country: "Sri Lanka"
+    }
+};
+
+stripe:Customer customerDetails = check stripe->/v1/customers.post(newCustomer);
+```
+
+#### List all customers
+
+```ballerina
+stripe:CustomerResourceCustomerList availableCustomers = check stripe->/v1/customers();
+```

ballerina/Package.md

@@ -0,0 +1,84 @@
+## Overview
+
+[Stripe](https://stripe.com/) is a leading online payment processing platform that simplifies the handling of financial transactions over the Internet. Stripe is renowned for its ease of integration, comprehensive documentation, and robust API that supports a wide range of payment operations including credit card transactions, subscription management, and direct payouts to user bank accounts.
+
+The Ballerina Stripe Connector allows developers to interact with the [Stripe REST API V1](https://stripe.com/docs/api), enabling seamless integration of Stripe’s extensive payment processing capabilities into Ballerina applications. This connector facilitates the automation of various payment-related operations such as charge creation, customer management, billing, and direct payouts. By leveraging the Ballerina Stripe Connector, developers can build secure and scalable payment solutions that enhance the e-commerce capabilities of their applications.
+
+## Setup guide
+
+To use the Ballerina Stripe connector, you must have a Stripe account and an API token for authentication. Follow the steps below to set up the connector with your Stripe account. If you don't have an account, you can create one by visiting [Stripe Sign Up page](https://dashboard.stripe.com/register) and completing the registration process.
+
+### Step 1: Log in to Stripe
+
+1. Sign in to your [Stripe dashboard](https://dashboard.stripe.com/login).
+
+### Step 2: Go to the developer portal
+
+1. Click on the **Developers** button in the top-right corner.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-dashboard.png alt="Stripe dashboard" style="width: 70%;">   
+
+### Step 3: Retrieve the secret key
+
+1. Go to **API keys** section in the nav-bar.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-developer-portal.png alt="Stripe dashboard" style="width: 70%;">   
+
+2. Retrieve the **Secret key**.
+
+    <img src=https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-stripe/main/docs/setup/resources/stripe-api-keys.png alt="Stripe dashboard" style="width: 70%;">   
+
+> **Note:** If you need to have more granular permissions for the keys, you could setup and use `Restricted keys`.
+
+## Quickstart
+
+To begin using the `Stripe` connector in your Ballerina application, you'll need to follow these steps:
+
+### Step 1: Import the connector
+
+First, import the `ballerinax/stripe` package into your Ballerina project.
+
+```ballerina
+import ballerinax/stripe;
+```
+
+### Step 2: Instantiate a new connector
+
+Create a `stripe:ConnectionConfig` object with API token, and initialize the connector.
+
+```ballerina
+configurable string secretKey = ?;
+
+stripe:ConnectionConfig configuration = {
+    auth: {
+        token: secretKey
+    }
+};
+
+stripe:Client stripe = check new (configuration);
+```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+#### Create a new customer
+
+```ballerina
+stripe:v1_customers_body newCustomer = {
+    name: "John Doe",
+    email: "[email protected]",
+    address: {
+        city: "Colombo",
+        country: "Sri Lanka"
+    }
+};
+
+stripe:Customer customerDetails = check stripe->/v1/customers.post(newCustomer);
+```
+
+#### List all customers
+
+```ballerina
+stripe:CustomerResourceCustomerList availableCustomers = check stripe->/v1/customers();
+```