chore(integrations): add description inside each integration's readme (#47)

michaelmass · web-flow · commit c4ba8e082196 · 2023-06-22T15:37:09.000-04:00
diff --git a/integrations/discord/integration.definition.ts b/integrations/discord/integration.definition.ts
@@ -5,6 +5,7 @@ import { z } from 'zod'
 export default new IntegrationDefinition({
   name: 'discord',
   version: '0.2.0',
+  readme: 'readme.md',
   configuration: {
     schema: z.object({
       apikey: z.string(),
diff --git a/integrations/discord/readme.md b/integrations/discord/readme.md
@@ -0,0 +1 @@
+Discord Integration for Botpress: Enhance your Botpress-powered conversational AI with seamless integration to Discord, the popular communication platform for communities and gaming. With this integration, your bot can interact directly with Discord servers, channels, and users, enabling dynamic conversations, automated responses, and rich multimedia interactions. Engage your Discord community, provide instant support, and automate routine tasks with ease. Leverage Discord's extensive feature set, including real-time messaging, voice chat, role management, and more, all integrated seamlessly with your Botpress-powered AI. Level up your conversational experiences and foster vibrant communities with the Discord Integration for Botpress.
diff --git a/integrations/github/integration.definition.ts b/integrations/github/integration.definition.ts
@@ -9,6 +9,7 @@ export default new IntegrationDefinition({
   title: 'GitHub',
   version: '0.2.0',
   icon: 'icon.svg',
+  readme: 'readme.md',
   description: 'Github integration for Botpress',
   configuration,
   actions,
diff --git a/integrations/github/readme.md b/integrations/github/readme.md
@@ -1,5 +1 @@
-# Github
-
-## Description
-
-This integration allows your bot to interact with Github.
+Streamline your development workflow by seamlessly integrating GitHub with Botpress, the open-source conversational AI platform. This integration enables you to effortlessly manage and automate your GitHub repositories, issues, and pull requests directly from Botpress, empowering you to collaborate effectively, track progress, and ensure smooth development cycles. Take advantage of powerful features like real-time notifications, issue management, pull request merging, and more, all within the familiar Botpress environment. Boost productivity, streamline collaboration, and unleash the full potential of your conversational AI projects with the GitHub Integration for Botpress.
diff --git a/integrations/gmail/readme.md b/integrations/gmail/readme.md
@@ -1,5 +1 @@
-# Gmail
-
-## Description
-
-This integration allows your bot to interact with Gmail.
+Simplify your email communication and supercharge your chatbot with seamless integration between Botpress and Gmail. Experience the power of combining your AI-powered chatbot with the versatility of Gmail, empowering you to streamline workflows, automate tasks, and deliver exceptional customer experiences. Unlock a world of possibilities as your chatbot seamlessly interacts with your Gmail inbox, managing emails, composing messages, and executing actions with ease. Leverage Gmail's robust features, such as advanced search, labeling, and filtering, to efficiently organize and respond to emails. Elevate your chatbot's capabilities and revolutionize your email-based interactions with the Botpress and Gmail Integration.
diff --git a/integrations/instagram/readme.md b/integrations/instagram/readme.md
@@ -1,5 +1 @@
-# Instagram
-
-## Description
-
-This integration allows your bot to interact with Instagram.
+This integration enables your bot to seamlessly interact with Instagram, allowing you to harness the power of social media in your conversational AI experiences. Connect your AI-powered chatbot to Instagram to automate interactions, engage with your audience, and deliver personalized experiences. Leverage the Instagram integration to send and receive messages, manage comments, handle direct messages, and respond in real-time. Streamline your social media strategy and elevate your customer engagement with the Instagram Integration for Botpress.
diff --git a/integrations/intercom/readme.md b/integrations/intercom/readme.md
@@ -1,5 +1 @@
-# Intercom
-
-## Description
-
-This integration allows your bot to interact with Intercom.
+The Intercom integration empowers your conversational AI by seamlessly integrating Botpress with Intercom's powerful customer messaging platform. Connect your AI-powered chatbot to Intercom and engage with your customers in real-time through personalized conversations. With this integration, you can automate customer support, handle inquiries, collect feedback, and nurture leads directly within Intercom. Leverage Intercom's features such as live chat, user segmentation, event tracking, and in-app messaging to deliver exceptional customer experiences. Streamline your customer communication and take your conversational AI to new heights with the Intercom Integration for Botpress.
diff --git a/integrations/line/readme.md b/integrations/line/readme.md
@@ -1,5 +1 @@
-# Line
-
-## Description
-
-This integration allows your bot to interact with Line.
+The Line integration enables your chatbot to seamlessly interact with Line, one of the leading messaging platforms. Connect your AI-powered chatbot to Line and unlock powerful communication capabilities to engage with your audience. With this integration, you can automate customer interactions, provide instant support, deliver personalized messages, and handle inquiries seamlessly within the Line messaging environment. Leverage Line's rich features such as text, images, stickers, and location sharing to create dynamic and engaging conversations. Elevate your chatbot's reach and impact by integrating it with Line using the Line Integration for Botpress.
diff --git a/integrations/linear/readme.md b/integrations/linear/readme.md
@@ -1,5 +1 @@
-# Linear
-
-## Description
-
-This integration allows your bot to interact with Linear.
+The Linear integration brings powerful project management capabilities to your AI-powered chatbot. Seamlessly connect Botpress with Linear, a modern issue tracking and workflow management tool. With this integration, you can automate task creation, track progress, and collaborate on projects directly within your chatbot. Empower your chatbot to create, update, and retrieve Linear issues, assign tasks to team members, track due dates, and more. Streamline your project management processes and enhance team productivity with the Linear Integration for Botpress.
diff --git a/integrations/messenger/readme.md b/integrations/messenger/readme.md
@@ -1,5 +1 @@
-# Messenger
-
-## Description
-
-This integration allows your bot to interact with Messenger.
+The Messenger integration empowers your chatbot to seamlessly interact with Facebook Messenger, one of the most popular messaging platforms. Connect your AI-powered chatbot to Messenger and engage with your audience in real-time conversations. With this integration, you can automate customer support, provide personalized recommendations, send notifications, and handle inquiries directly within Messenger. Leverage Messenger's rich features, including text, images, buttons, quick replies, and more, to create dynamic and engaging chatbot experiences. Take your customer engagement to the next level with the Messenger Integration for Botpress.
diff --git a/integrations/slack/readme.md b/integrations/slack/readme.md
@@ -1,5 +1 @@
-# Slack
-
-## Description
-
-This integration allows your bot to interact with Slack.
+The Slack integration enables seamless communication between your AI-powered chatbot and Slack, the popular collaboration platform. Connect your chatbot to Slack and streamline team communication, automate tasks, and enhance productivity. With this integration, your chatbot can send and receive messages, share updates, handle inquiries, and perform actions directly within Slack channels. Leverage Slack's extensive features such as chat, file sharing, notifications, and app integrations to create a powerful conversational AI experience. Enhance team collaboration and streamline workflows with the Slack Integration for Botpress.
diff --git a/integrations/sunco/readme.md b/integrations/sunco/readme.md
@@ -1,5 +1 @@
-# Sunco
-
-## Description
-
-This integration allows your bot to interact with Sunco.
+The Sunshine Conversations integration enables your AI-powered chatbot to seamlessly connect with Sunshine Conversations, a powerful omnichannel messaging platform. Integrate your chatbot with Sunshine Conversations to engage with your customers across various messaging channels, including WhatsApp, Facebook Messenger, SMS, and more. With this integration, you can automate customer interactions, provide personalized support, and deliver rich messaging experiences. Leverage Sunshine Conversations' features such as chat routing, message templates, conversation history, and analytics to optimize your customer engagement strategy. Take your chatbot's reach and capabilities to new heights with the Sunshine Conversations Integration for Botpress.
diff --git a/integrations/teams/readme.md b/integrations/teams/readme.md
@@ -1,25 +1 @@
-# Integration Teams
-
-## Description
-
-This integration allows your bot to interact with Microsoft Teams.
-
-## Usage
-
-1. Build the bot using command `pnpm bp build`
-2. Deploy the bot using command `pnpm bp deploy`
-
-## Running locally
-
-There are few different ways of running your integration locally:
-
-```sh
-# 1. To run the bundle created by the build command:
-
-pnpm bp serve --port 9999
-
-# 2. To run with ts-node:
-
-start_script="import integration from './src'; void integration.start()"
-ts-node -T -r @botpress/cli/init -e $start_script
-```
+The Microsoft Teams integration enables seamless collaboration between your AI-powered chatbot and Microsoft Teams, a popular workplace communication and collaboration platform. Connect your chatbot to Teams and enhance team productivity by automating tasks, providing instant support, and facilitating streamlined communication. With this integration, your chatbot can interact with users in Teams channels, respond to queries, deliver notifications, and perform actions within the Teams environment. Leverage Teams' robust features such as messaging, file sharing, meetings, and app integrations to create a powerful conversational AI experience. Boost teamwork and efficiency with the Microsoft Teams Integration for Botpress.
diff --git a/integrations/telegram/readme.md b/integrations/telegram/readme.md
@@ -1,5 +1 @@
-# Telegram
-
-## Description
-
-This integration allows your bot to interact with Telegram.
+The Telegram integration allows your AI-powered chatbot to seamlessly interact with Telegram, a popular messaging platform with a large user base. Connect your chatbot to Telegram and engage with your audience in real-time conversations. With this integration, you can automate customer support, provide personalized recommendations, send notifications, and handle inquiries directly within Telegram. Leverage Telegram's rich features, including text messages, inline buttons, media files, and more, to create dynamic and interactive chatbot experiences. Empower your chatbot to deliver exceptional user experiences on Telegram with the Telegram Integration for Botpress.
diff --git a/integrations/twilio/readme.md b/integrations/twilio/readme.md
@@ -1,5 +1 @@
-# Twilio
-
-## Description
-
-This integration allows your bot to interact with Twilio.
+The Twilio integration enables seamless communication between your AI-powered chatbot and Twilio, a powerful cloud communications platform. Connect your chatbot to Twilio and leverage a wide range of communication channels, including SMS, voice calls, and messaging apps. With this integration, you can automate interactions, send personalized notifications, handle inquiries, and provide customer support directly through Twilio. Utilize Twilio's extensive features such as SMS delivery, call routing, message templates, and more to create robust and efficient conversational experiences. Enhance your communication strategy and reach customers effectively with the Twilio Integration for Botpress.
diff --git a/integrations/viber/readme.md b/integrations/viber/readme.md
@@ -1,5 +1 @@
-# Viber
-
-## Description
-
-This integration allows your bot to interact with Viber.
+The Viber integration allows your AI-powered chatbot to seamlessly connect with Viber, a popular messaging platform with a global user base. Integrate your chatbot with Viber to engage with your audience in real-time conversations, provide instant support, and deliver personalized experiences. With this integration, you can automate interactions, send messages, handle inquiries, and perform actions directly within Viber. Leverage Viber's features such as text messages, rich media, stickers, and chatbot extensions to create engaging and interactive chatbot experiences. Expand your reach and connect with Viber users effectively with the Viber Integration for Botpress.
diff --git a/integrations/vonage/readme.md b/integrations/vonage/readme.md
@@ -1,5 +1 @@
-# Vonage
-
-## Description
-
-This integration allows your bot to interact with Vonage.
+The Vonage integration enables seamless communication between your AI-powered chatbot and Vonage, a leading cloud communications platform. Connect your chatbot to Vonage and leverage a variety of communication channels, including SMS, voice calls, and messaging apps. With this integration, you can automate interactions, send notifications, handle inquiries, and provide customer support directly through Vonage. Utilize Vonage's robust features such as SMS delivery, voice call routing, messaging app integration, and more to create reliable and effective conversational experiences. Enhance your communication capabilities and engage with users effortlessly with the Vonage Integration for Botpress.
diff --git a/integrations/webchat/readme.md b/integrations/webchat/readme.md
@@ -1,12 +1 @@
-# Webchat
-
-## Description
-
-How to test:
-
-1. Open developer tools & go to network tab
-2. Open app.botpress.cloud
-3. Inspect the call https://controller.botpress.dev/v2/bots/xxxxx
-4. On preview tab, drill down on "integrations", then copy params under configuration in your bot's integration config
-5. Disable the official webchat integration
-6. Put those parameters to configure your webchat integration, then save
+The Webchat built by Botpress empowers you to create engaging and personalized chat experiences on your website or application. With this platform, you can leverage the power of Botpress, an AI-powered chatbot framework, to build and deploy chatbots that seamlessly integrate with your website or application. Customize the look and feel of the chat interface to match your brand, tailor the conversation flow to meet your specific requirements, and utilize advanced features such as natural language understanding, intent recognition, and dialog management. With the Webchat, you have full control over the chatbot's behavior and can provide exceptional conversational experiences to your users. Elevate your customer engagement and drive meaningful interactions with the Webchat for Botpress.
diff --git a/integrations/webhook/readme.md b/integrations/webhook/readme.md
@@ -1,5 +1 @@
-# Webhook
-
-## Description
-
-This integration allows your bot to interact with Webhook.
+The Webhook integration allows your AI-powered chatbot to seamlessly connect with external systems and services using HTTP-based webhooks. With this integration, you can send and receive data from any system that supports webhooks, enabling your chatbot to interact with external APIs, databases, CRMs, and more. Customize your chatbot's behavior by triggering actions, retrieving information, and updating data through webhook interactions. Leverage the power of webhooks to integrate your chatbot with your existing infrastructure and external services, expanding its capabilities and enabling seamless integration with your preferred systems. Connect your chatbot to the world with the Webhook Integration for Botpress.
diff --git a/integrations/whatsapp/readme.md b/integrations/whatsapp/readme.md
@@ -1,5 +1 @@
-# Whatsapp
-
-## Description
-
-This integration allows your bot to interact with Whatsapp.
+The WhatsApp integration allows your AI-powered chatbot to seamlessly connect with WhatsApp, one of the most popular messaging platforms worldwide. Integrate your chatbot with WhatsApp to engage with your audience, automate conversations, and provide instant support. With this integration, you can send messages, handle inquiries, deliver notifications, and perform actions directly within WhatsApp. Leverage WhatsApp's powerful features such as text messages, media sharing, document sharing, and more to create personalized and interactive chatbot experiences. Connect with users on a platform they already use and enhance customer engagement with the WhatsApp Integration for Botpress.
diff --git a/integrations/zapier/readme.md b/integrations/zapier/readme.md
@@ -1,5 +1 @@
-# Zapier
-
-## Description
-
-This integration allows your bot to interact with Zapier.
+The Zapier integration enables seamless integration between your AI-powered chatbot and Zapier, a powerful automation platform. Connect your chatbot to Zapier and unlock endless possibilities for automating workflows and integrating with various third-party apps and services. With this integration, you can easily create custom workflows, automate tasks, and streamline data transfers between your chatbot and other apps. Leverage Zapier's extensive library of supported apps to connect your chatbot with CRMs, email marketing platforms, project management tools, and much more. Simplify your workflows and enhance the capabilities of your chatbot with the Zapier Integration for Botpress.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Discord Integration for Botpress: Enhance your Botpress-powered conversational AI with seamless integration to Discord, the popular communication platform for communities and gaming. With this integration, your bot can interact directly with Discord servers, channels, and users, enabling dynamic conversations, automated responses, and rich multimedia interactions. Engage your Discord community, provide instant support, and automate routine tasks with ease. Leverage Discord's extensive feature set, including real-time messaging, voice chat, role management, and more, all integrated seamlessly with your Botpress-powered AI. Level up your conversational experiences and foster vibrant communities with the Discord Integration for Botpress.