Skip to content

Commit 1171620

Browse files
tracyboehrerTracy Boehrer
tracyboehrer
and
Tracy Boehrer
authored
Updated README (microsoft#6621)
* Updated README * More README updates --------- Co-authored-by: Tracy Boehrer <trboehre@microsoft.com>
1 parent e9099c6 commit 1171620

1 file changed

Lines changed: 61 additions & 71 deletions

File tree

‎README.md‎

Lines changed: 61 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -6,91 +6,85 @@ Bot Framework provides the most comprehensive experience for building conversati
66

77
With the [Bot Framework SDK](#bot-framework-sdk-v4), developers can build bots that converse free-form or with guided interactions including using simple text or rich cards that contain text, images, and action buttons.
88

9-
Developers can model and build sophisticated conversation using their favorite programming languages including C#, JS, Python and Java or using [Bot Framework Composer](https://aka.ms/bfcomposer), an open-source, visual authoring canvas for developers and multi-disciplinary teams to design and build conversational experiences with Language Understanding, QnA Maker and sophisticated composition of bot replies (Language Generation).
9+
Developers can model and build sophisticated conversation using their favorite programming languages including C#, JS, and Python for developers and multi-disciplinary teams to design and build conversational experiences.
1010

1111
Checkout the [Bot Framework ecosystem](#bot-framework-ecosystem) section to learn more about other tooling and services related to the Bot Framework SDK.
1212

13-
![Bot Framework SDK](./docs/media/GitHubBannerV2.gif)
14-
1513
## Quicklinks
16-
| [Bot Framework Composer](https://aka.ms/bfcomposer) | [C# Repo](https://github.com/Microsoft/botbuilder-dotnet) | [JS Repo](https://github.com/Microsoft/botbuilder-js) | [Python Repo](https://github.com/Microsoft/botbuilder-python) | [Java Repo](https://github.com/Microsoft/botbuilder-java) | [BF CLI](https://github.com/Microsoft/botframework-cli) |
14+
| [C# Repo](https://github.com/Microsoft/botbuilder-dotnet) | [JS Repo](https://github.com/Microsoft/botbuilder-js) | [Python Repo](https://github.com/Microsoft/botbuilder-python) | [BF CLI](https://github.com/Microsoft/botframework-cli) |
1715

1816
## Bot Framework SDK v4
1917
The Bot Framework SDK v4 is an [open source SDK][1a] that enable developers to model and build sophisticated conversation using their favorite programming language.
2018

21-
| | C# | JS | Python | Java |
22-
|---|:---:|:---:|:------:|:-----:|
23-
|Stable Release |[packages][1] | [packages][2] | [packages][3] | [packages][3a]|
24-
|Docs | [docs][5] |[docs][5] |[docs][5] |[docs][5] |
25-
|Samples |[.NET Core][6], [WebAPI][10] |[Node.js][7] , [TypeScript][8], [es6][9] | [Python][111] | [Java][112] |
19+
| | C# | JS | Python |
20+
|---|:---:|:---:|:------:|
21+
|Stable Release |[packages][1] | [packages][2] | [packages][3] |
22+
|Docs | [docs][5] |[docs][5] |[docs][5] |
23+
|Samples |[.NET Core][6], [WebAPI][10] |[Node.js][7] , [TypeScript][8], [es6][9] | [Python][111] |
2624

2725
[1a]:https://github.com/microsoft/botframework-sdk/#readme
2826
[1]:https://github.com/Microsoft/botbuilder-dotnet/#packages
2927
[2]:https://github.com/Microsoft/botbuilder-js#packages
3028
[3]:https://github.com/microsoft/botbuilder-python/#packages
31-
[3a]:https://github.com/microsoft/botbuilder-java/#packages
32-
[4]:https://github.com/Microsoft/botbuilder-java#packages
3329
[5]:https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0
3430
[6]:https://github.com/Microsoft/BotBuilder-Samples/tree/main/samples/csharp_dotnetcore
3531
[7]:https://github.com/Microsoft/BotBuilder-Samples/tree/main/samples/javascript_nodejs
3632
[8]:https://github.com/Microsoft/BotBuilder-Samples/tree/main/samples/typescript_nodejs
3733
[9]:https://github.com/Microsoft/BotBuilder-Samples/tree/main/samples/javascript_es6
3834
[10]:https://github.com/Microsoft/BotBuilder-Samples/tree/main/samples/csharp_webapi
3935
[111]:https://github.com/microsoft/BotBuilder-Samples/tree/main/samples/python
40-
[112]: https://github.com/microsoft/BotBuilder-Samples/tree/main/samples/java_springboot
4136

4237
## Channels and Adapters
4338
There are two ways to connect your bot to a client experience:
4439
* **Azure Bot Service Channel** - Language and SDK independent support via Azure Bot Service
4540
* **Bot Framework SDK Adapter** - A per language Adapter component
4641

47-
| Client | Azure Channel | C# Adapter | JS Adapter | Python Adapter |
48-
|-----------------|:--------------:|:--------------------:|:-----------------:|:------------------:|
49-
| Microsoft Teams | [Azure][55abs] | | | |
50-
| Direct Line | [Azure][55abs] | | | |
51-
| Web Chat | [Azure][55abs] | | [Botkit][55bk] | |
52-
| Skype | [Azure][55abs] | | | |
53-
| Email | [Azure][55abs] | | | |
54-
| Facebook | [Azure][55abs] | [SDK][55sdkcsfb] | [Botkit][55bk] | |
55-
| Slack | [Azure][55abs] | [SDK][55sdkcsslack] | [Botkit][55bk] | [SDK][55sdkpyslack] |
56-
| Kik | [Azure][55abs] | | | |
57-
| Telegram | [Azure][55abs] | | | |
58-
| Line | [Azure][55abs] | | | |
59-
| GroupMe | [Azure][55abs] | | | |
60-
| Twilio (SMS) | [Azure][55abs] | [SDK][55sdkcstwilio] | [Botkit][55bk] | |
61-
| Alexa Skills | | [Community][55cs] | [Community][55js] | |
62-
| Google Actions | | [Community][55cs] | [Community][55js] | |
63-
| Google Hangouts | | | [Botkit][55bk] | |
64-
| WebEx | | [SDK][55sdkcswebex] | [Botkit][55bk] | |
65-
| WhatsApp (Infobip) | | [Community][55cs] | | |
66-
| Zoom | | [Community][55cs] | | |
67-
| RingCentral | | [Community][55cs] | | |
68-
| Cortana | [Azure][55abs] | | | |
69-
| Console | | | [Community][55js] | |
42+
| Client | Azure Channel | C# Adapter | JS Adapter |
43+
|-----------------|:--------------:|:--------------------:|:-----------------:|
44+
| Microsoft Teams | [Azure][55abs] | | |
45+
| Direct Line | [Azure][55abs] | | |
46+
| Web Chat | [Azure][55abs] | | [Botkit][55bk] |
47+
| Skype | [Azure][55abs] | | |
48+
| Email | [Azure][55abs] | | |
49+
| Facebook | [Azure][55abs] | [Community][55sdkcsfb] | [Botkit][55bk] |
50+
| Slack | [Azure][55abs] | [Community][55sdkcsslack] | [Botkit][55bk] |
51+
| Kik | [Azure][55abs] | | |
52+
| Telegram | [Azure][55abs] | | |
53+
| Line | [Azure][55abs] | | |
54+
| GroupMe | [Azure][55abs] | | |
55+
| Twilio (SMS) | [Azure][55abs] | [Community][55sdkcstwilio] | [Botkit][55bk] |
56+
| Alexa Skills | | [Community][55cs] | [Community][55js] |
57+
| Google Actions | | [Community][55cs] | [Community][55js] |
58+
| Google Hangouts | | | [Botkit][55bk] |
59+
| WebEx | | [Community][55sdkcswebex] | [Botkit][55bk] |
60+
| WhatsApp (Infobip) | | [Community][55cs] | |
61+
| Zoom | | [Community][55cs] | |
62+
| RingCentral | | [Community][55cs] | |
63+
| Cortana | [Azure][55abs] | | |
64+
| Console | | | [Community][55js] |
7065

7166
[55abs]:https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0
7267
[55cs]:https://github.com/BotBuilderCommunity/botbuilder-community-dotnet#adapters
7368
[55js]:https://github.com/BotBuilderCommunity/botbuilder-community-js#adapters
7469
[55bk]:https://github.com/howdyai/botkit#readme
75-
[55sdkcsfb]:https://github.com/microsoft/botbuilder-dotnet/tree/main/libraries/Adapters/Microsoft.Bot.Builder.Adapters.Facebook
76-
[55sdkcsslack]:https://github.com/microsoft/botbuilder-dotnet/tree/main/libraries/Adapters/Microsoft.Bot.Builder.Adapters.Slack
77-
[55sdkcstwilio]:https://github.com/microsoft/botbuilder-dotnet/tree/main/libraries/Adapters/Microsoft.Bot.Builder.Adapters.Twilio
78-
[55sdkcswebex]:https://github.com/microsoft/botbuilder-dotnet/tree/main/libraries/Adapters/Microsoft.Bot.Builder.Adapters.Webex
70+
[55sdkcsfb]:https://github.com/BotBuilderCommunity/botbuilder-community-dotnet/tree/develop/libraries/Bot.Builder.Community.Adapters.Facebook
71+
[55sdkcsslack]:https://github.com/BotBuilderCommunity/botbuilder-community-dotnet/tree/develop/libraries/Bot.Builder.Community.Adapters.Slack
72+
[55sdkcstwilio]:https://github.com/BotBuilderCommunity/botbuilder-community-dotnet/tree/develop/libraries/Bot.Builder.Community.Adapters.Twilio
73+
[55sdkcswebex]:https://github.com/BotBuilderCommunity/botbuilder-community-dotnet/tree/develop/libraries/Bot.Builder.Community.Adapters.Webex
7974
[55sdkpyslack]:https://github.com/microsoft/botbuilder-python/tree/main/libraries/botbuilder-adapters-slack
8075

8176
## Community Open Source Projects
8277
The following open source communities make various components available to extend your bot application, including adapters, recognizers, dialogs and middleware.
8378

84-
| | C# | JavaScript | Python | Java |
85-
|----------------------------|:--------------:|:----------:|:--------------:|:------------:|
86-
| [Bot Framework Community][56] | [C#][56dotnet] | [JavaScript][56js] | [Python][56py] | [Java][56ja] |
87-
| [Botkit][56bk] | | [JavaScript][56bk] | | |
79+
| | C# | JavaScript | Python |
80+
|----------------------------|:--------------:|:----------:|:--------------:|
81+
| [Bot Framework Community][56] | [C#][56dotnet] | [JavaScript][56js] | [Python][56py] |
82+
| [Botkit][56bk] | | [JavaScript][56bk] | |
8883

8984
[56]:https://github.com/botbuildercommunity#readme
9085
[56dotnet]:https://github.com/botbuildercommunity/botbuilder-community-dotnet#readme
9186
[56js]:https://github.com/botbuildercommunity/botbuilder-community-js#readme
9287
[56py]:https://github.com/botbuildercommunity/botbuilder-community-python#readme
93-
[56ja]:https://github.com/botbuildercommunity/botbuilder-community-java#readme
9488
[56bk]:https://github.com/howdyai/botkit#readme
9589

9690
## Questions and Help
@@ -110,56 +104,33 @@ We track functional issues and features asks for the Bot Framework SDK, tools an
110104
| SDK v4 .NET | core bot runtime for .NET, connectors, middleware, dialogs, prompts, LUIS and QnA | [File an issue][70csissues] |
111105
| SDK v4 JavaScript | core bot runtime for Typescript/Javascript, connectors, middleware, dialogs, prompts, LUIS and QnA | [File an issue][70jsissues] |
112106
| SDK v4 Python | core bot runtime for Python, connectors, middleware, dialogs, prompts, LUIS and QnA | [File an issue][70pyissues] |
113-
| SDK v4 Java | core bot runtime for Java, connectors, middleware, dialogs, prompts, LUIS and QnA | [File an issue][70jaissues] |
114-
| Bot Framework Composer | bot framework composer electron and web app | [File an issue][70composerissues] |
115107
| Bot Framework CLI | bot framework cli tools | [File an issue][70cliissues] |
116108
| Webchat | bot framework web chat tool | [File an issue][70webchatissues] |
117109

118110
[70csissues]:https://github.com/Microsoft/botbuilder-dotnet/issues
119111
[70jsissues]:https://github.com/Microsoft/botbuilder-js/issues
120112
[70pyissues]:https://github.com/Microsoft/botbuilder-python/issues
121-
[70jaissues]:https://github.com/Microsoft/botbuilder-java/issues
122113
[70cliissues]:https://github.com/Microsoft/botframework-cli/issues
123-
[70composerissues]:https://github.com/Microsoft/botframework-composer/issues
124114
[70webchatissues]:https://github.com/Microsoft/botframework-webchat/issues
125115

126116
## Prior releases
127117

128-
- Bot Builder v3 SDK has been migrated to the [Bot Framework SDK V3](https://github.com/microsoft/botbuilder-v3) repository.
118+
- Bot Builder v3 SDK has been migrated to the [Bot Framework SDK V3](https://github.com/microsoft/botbuilder-v3) repository. The V3 SDK is retired with final long-term support ending on December 31st, 2019
129119

130120
## Bot Framework ecosystem
131121

132-
- [Bot Framework Composer](#Bot-Framework-Composer)
133-
- [Botkit](#Botkit)
134122
- [Azure Bot Service](#Azure-Bot-Service)
135123
- [Bot Framework Emulator](#Bot-Framework-Emulator)
136124
- [Bot Framework Web Chat](#Bot-Framework-Web-Chat)
137-
- [Bot Framework Tools](#Bot-Framework-CLI-Tools)
125+
- [Bot Framework CLI](#Bot-Framework-CLI)
138126
- [Language Understanding](#Language-Understanding)
139127
- [QnA Maker](#QnA-Maker)
140128
- [Dispatch](#Dispatch)
141129
- [Speech Services](#Speech-Services)
142130
- [Adaptive cards](#Adaptive-Cards)
143131
- [Analytics](#Analytics)
144-
145-
### Bot Framework Composer
146-
[Bot Framework Composer](https://github.com/microsoft/BotFramework-Composer/blob/main/README.md) is an integrated development tool for developers and multi-disciplinary teams to build bots and conversational experiences with the Microsoft Bot Framework. Within this tool, you'll find everything you need to build a sophisticated conversational experience.
147-
148-
### Botkit
149-
[Botkit][100] is a developer tool and SDK for building chat bots, apps and custom integrations for major messaging platforms. Botkit bots `hear()` triggers, `ask()` questions and `say()` replies. Developers can use this syntax to build dialogs - now cross compatible with the latest version of Bot Framework SDK.
150-
151-
In addition, Botkit brings with it 6 platform adapters allowing Javascript bot applications to communicate directly with messaging platforms: [Slack][102], [Webex Teams][103], [Google Hangouts][104], [Facebook Messenger][105], [Twilio][106], and [Web chat][107].
152-
153-
Botkit is part of Microsoft Bot Framework and is released under the [MIT Open Source license][101]
154-
155-
[100]:https://github.com/howdyai/botkit#readme
156-
[101]:https://github.com/howdyai/botkit/blob/main/LICENSE.md
157-
[102]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-slack#readme
158-
[103]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-webex#readme
159-
[104]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-hangouts#readme
160-
[105]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-facebook#readme
161-
[106]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-twilio-sms#readme
162-
[107]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-web#readme
132+
- [Bot Framework Composer](#Bot-Framework-Composer)
133+
- [Botkit](#Botkit)
163134

164135
### Azure Bot Service
165136
Azure Bot Service enables you to host intelligent, enterprise-grade bots with complete ownership and control of your data. Developers can register and connect their bots to users on Skype, Microsoft Teams, Cortana, Web Chat, and more. [[Docs][28]]
@@ -195,6 +166,25 @@ The Bot Framework [Web Chat][23] is a highly customizable web-based client chat
195166
### Bot Framework CLI
196167
The Bot Framework CLI Tools hosts the [open source](https://github.com/microsoft/botframework-cli) cross-platform Bot Framework CLI tool, designed to support building robust end-to-end development workflows. The Bot Framework CLI tool replaced the [legacy standalone tools](https://github.com/Microsoft/BotBuilder-Tools) used to manage bots and related services. BF CLI aggregates the collection of cross-platform tools into one cohesive and consistent interface.
197168

169+
### Bot Framework Composer
170+
[Bot Framework Composer](https://github.com/microsoft/BotFramework-Composer/blob/main/README.md) is an integrated development tool for developers and multi-disciplinary teams to build bots and conversational experiences with the Microsoft Bot Framework. Within this tool, you'll find everything you need to build a sophisticated conversational experience.
171+
172+
### Botkit
173+
[Botkit][100] is a developer tool and SDK for building chat bots, apps and custom integrations for major messaging platforms. Botkit bots `hear()` triggers, `ask()` questions and `say()` replies. Developers can use this syntax to build dialogs - now cross compatible with the latest version of Bot Framework SDK.
174+
175+
In addition, Botkit brings with it 6 platform adapters allowing Javascript bot applications to communicate directly with messaging platforms: [Slack][102], [Webex Teams][103], [Google Hangouts][104], [Facebook Messenger][105], [Twilio][106], and [Web chat][107].
176+
177+
Botkit is part of Microsoft Bot Framework and is released under the [MIT Open Source license][101]
178+
179+
[100]:https://github.com/howdyai/botkit#readme
180+
[101]:https://github.com/howdyai/botkit/blob/main/LICENSE.md
181+
[102]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-slack#readme
182+
[103]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-webex#readme
183+
[104]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-hangouts#readme
184+
[105]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-facebook#readme
185+
[106]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-twilio-sms#readme
186+
[107]:https://github.com/howdyai/botkit/tree/main/packages/botbuilder-adapter-web#readme
187+
198188
## Related Services
199189

200190
### Language Understanding

0 commit comments

Comments
 (0)