From 2e66c85ba96fa2be334fc661c8de944471975b24 Mon Sep 17 00:00:00 2001
From: Nipuna Ranasinghe <nipunaranasinghe93@gmail.com>
Date: Thu, 4 Jul 2024 09:44:07 +0530
Subject: [PATCH] Add Package.md

---
 ballerina/Package.md | 84 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)

diff --git a/ballerina/Package.md b/ballerina/Package.md
index e69de29..dfbedbb 100644
--- a/ballerina/Package.md
+++ b/ballerina/Package.md
@@ -0,0 +1,84 @@
+## Overview
+
+[Slack](https://slack.com/) is a collaboration platform for teams, offering real-time messaging, file sharing, and integrations with various tools. It helps streamline communication and enhance productivity through organized channels and direct messaging.
+
+## Setup guide
+
+To use the Slack Connector you need to be signed in to [Slack](https://slack.com/).
+
+![Sign In Page](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-slack/master/docs/setup/resources/sign-in.png)
+
+If you haven't created an account already, you can create it [here](https://slack.com/get-started#/createnew).
+
+### Step 1: Create a new Slack application
+
+1. Navigate to your apps in [Slack API](https://api.slack.com/) and create a new Slack app.
+
+![Create Slack App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-slack/master/docs/setup/resources/create-slack-app.png)
+
+2. Provide an app name and choose a workspace of your choice.
+
+![Create Slack App Popup](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-slack/master/docs/setup/resources/create-slack-app-2.png)
+
+3. Click on the "Create App" button.
+
+### Step 2: Add scopes to the token
+
+1. Once the application is created, go to the "Add Features and Functionality" section and click on "Permissions" to set the token scopes.
+
+![Add Features and Functionality](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-slack/master/docs/setup/resources/add-features.png)
+
+2. In the **User Token Scopes** section set the following token scopes.
+
+![User Token Scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-slack/master/docs/setup/resources/token-permissions.png)
+
+3. Install the application to workspace.
+
+![Install to workspace ](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-slack/master/docs/setup/resources/install-workspace.jpg)
+
+4. Copy the OAuth token that is generated upon installation.
+
+![Copy Token](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-slack/master/docs/setup/resources/copy-token.jpg)
+
+
+## Quickstart
+
+To use the `slack` connector in your Ballerina application, modify the `.bal` file as follows:
+
+### Step 1: Import the module
+
+Import the `slack` module.
+
+```ballerina
+import ballerinax/slack;
+```
+
+### Step 2: Instantiate a new connector
+
+Assign the OAuth token obtained to the variable **token**, and then initialize a new instance of the slack client by passing the token.
+
+```ballerina
+configurable string token = ?;
+
+slack:Client slack = check new({
+    auth: {
+        token
+    }
+});
+```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+#### Send a Text Message to General Channel
+
+```ballerina
+json postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"});
+```
+
+### Step 4: Run the Ballerina application
+
+```bash
+bal run
+```