From 7da7aa378b51d3d50ca6962e38121b31c0ca0381 Mon Sep 17 00:00:00 2001 From: Andrew Clear <1139814+clearab@users.noreply.github.com> Date: Tue, 27 Apr 2021 15:27:36 -0700 Subject: [PATCH] docs: Anclear/readme omega (#999) * abstract license terms * fixes #898 * fixes * align readmes * timm-eh * minor * base readme * Teams readme * Adaptive Cards readme * Update AdaptiveCards README * Update Teams README * Fixing various issues in the READMEs for the generators and components. * Updating command line instructions to provide more specific guidance and list out details for all published generators. * Adding documentation links provided in Ryan's feedback. Co-authored-by: Ryan Lengel Isgrig <43043272+ryanlengel@users.noreply.github.com> Co-authored-by: Peter Innes --- README.md | 4 +- generators/command-line-instructions.md | 39 +++++++++++ generators/generator-bot-adaptive/README.md | 65 ++++--------------- .../generator-bot-command-list/README.md | 45 ++++++------- .../generator-bot-core-assistant/README.md | 55 ++-------------- .../generator-bot-core-language/README.md | 54 ++------------- generators/generator-bot-core-qna/README.md | 47 ++------------ generators/generator-bot-empty/README.md | 50 ++------------ .../README.md | 43 ++---------- .../README.md | 47 ++------------ .../generator-bot-enterprise-people/README.md | 45 ++----------- .../README.md | 26 ++------ ...rosoft.Bot.Components.AdaptiveCards.csproj | 1 + packages/AdaptiveCards/README.md | 20 ++++++ .../Microsoft.Bot.Components.Teams.csproj | 1 + packages/Teams/README.md | 21 ++++++ 16 files changed, 159 insertions(+), 404 deletions(-) create mode 100644 generators/command-line-instructions.md create mode 100644 packages/AdaptiveCards/README.md create mode 100644 packages/Teams/README.md diff --git a/README.md b/README.md index 42b793b19..fa9203a9a 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ Templates are pre-built bot projects designed for specific scenarios. We use [ye |[Empty Bot](/generators/generator-bot-empty) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty) | The base empty bot. | |[Core Bot with Language](/generators/generator-bot-core-language) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language) | Basic conversational bot with NLP. | |[Command list](/generators/generator-bot-command-list) | | Basic bot using regex and cards. | +|[Core Assistant Bot](/generators/generator-bot-core-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant) | Basic assistant bot with no skills. | +|[Enterprise Assistant Bot](/generators/generator-bot-enterprise-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant) | Assistant Core + Calendar & People as skills. | |[Enterprise Calendar Bot](/generators/generator-bot-enterprise-calendar) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar) | A bot for working with Calendars. | |[Enterprise People Bot](/generators/generator-bot-enterprise-people) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people) | A bot for searching for people on the MS Graph. | |[Adaptive](/generators/generator-bot-adaptive) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive) | Used by other generators to scaffold web app or functions project. | -|[Core Assistant Bot](/generators/generator-bot-core-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant) | Basic assistant bot with no skills. | -|[Enterprise Assistant Bot](/generators/generator-bot-enterprise-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant) | Assistant Core + Calendar & People as skills. | ### Packages diff --git a/generators/command-line-instructions.md b/generators/command-line-instructions.md new file mode 100644 index 000000000..0a1b3a60f --- /dev/null +++ b/generators/command-line-instructions.md @@ -0,0 +1,39 @@ +# Command line instructions + +Our templates can also be used from the command-line. First, install [Yeoman][yeoman] using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): + +```bash +npm install -g yo +``` +Next, identify the template you would like to use from the table below: + +| Name | npm | Version | Platforms | Integrations | +|:----:|:---:|:-------:|:---------:|:------------:| +| [Empty Bot](/generator-bot-empty) | [@microsoft/generator-bot-empty](https://www.npmjs.com/package/@microsoft/generator-bot-empty) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty) | dotnet, js | webapp, functions | +| [Core Bot with Language](/generator-bot-core-language) | [@microsoft/generator-bot-core-language](https://www.npmjs.com/package/@microsoft/generator-bot-core-language) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language) | dotnet, js | webapp, functions | +| [Core Assistant Bot](/generator-bot-core-assistant) | [@microsoft/generator-bot-core-assistant](https://www.npmjs.com/package/@microsoft/generator-bot-core-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant) | dotnet | webapp, functions | +| [Enterprise Assistant Bot](/generator-bot-enterprise-assistant) | [@microsoft/generator-bot-enterprise-assistant](https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-assistant) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant) | dotnet | webapp, functions | +| [Enterprise Calendar Bot](/generator-bot-enterprise-calendar) | [@microsoft/generator-bot-enterprise-calendar](https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-calendar) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar) | dotnet | webapp, functions | +| [Enterprise People Bot](/generator-bot-enterprise-people) | [@microsoft/generator-bot-enterprise-people](https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-people) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people) | dotnet | webapp, functions | +| [Adaptive](/generator-bot-adaptive) | [@microsoft/generator-bot-adaptive](https://www.npmjs.com/package/@microsoft/generator-bot-adaptive) | [![npm version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg)](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive) | dotnet, js | webapp, functions | + +Once you have identified the template you would like to use, install it using [npm][npm]. For example, to install the Empty Bot template: + +```bash +npm install -g @microsoft/generator-bot-empty +``` + +Finally, generate your new project using [Yeoman][yeoman], taking note of the following: + +- Remove `generator` from the package name, e.g. `@microsoft/generator-bot-empty` becomes `@microsoft/bot-empty`. +- `--platform` and `--integration` match one of the listed values from template's platforms and integrations. + - `--platform` will default to **dotnet** if not specified. + - `--integration` will default to **webapp** if not specified. + +```bash +yo @microsoft/bot-empty '{BOT_NAME}' --platform '{dotnet|js}' --integration '{webapp|functions}' +``` + +[yeoman]: https://yeoman.io +[npm]: https://npmjs.com +[nodejs]: https://nodejs.org/ diff --git a/generators/generator-bot-adaptive/README.md b/generators/generator-bot-adaptive/README.md index c652afebe..0a2b5e5ba 100644 --- a/generators/generator-bot-adaptive/README.md +++ b/generators/generator-bot-adaptive/README.md @@ -1,70 +1,33 @@ # @microsoft/generator-bot-adaptive [![NPM version][npm-image]][npm-url] -This generator is a base for creating an Azure Bot Framework bot using the Adaptive Dialog stack. This generator is designed to be used as a base for other more purpose-specific generators, and is responsible for scaffolding: +This generator is for creating an Azure Bot Framework bot using the Adaptive Dialog stack. This generator is designed to be used as a base for other more purpose-specific generators, and is responsible for scaffolding: -- The basic bot project (code files, root dialog, base schema) for your bot, based on the platform you choose (dotnet or JavaScript) +- The basic bot project (code files, root dialog, base schema) for your bot, based on the platform you choose (.NET or JavaScript) - The publishing environment for your bot (Azure Functions, or a Web App) You can also use our [generator for generating bot generators](https://github.com/microsoft/botframework-components/tree/main/generators/generator-bot-template-generator) to help you create your own generators and templates. +## Supported Languages + +- English (en-US) + +## Resource Deployment + +This template contains scaffold code for publishing your bot to either Azure Functions, or Azure Web App. You can also choose to use neither option, and publish to your own web application hosting service of choice. + ## Usage ### Creating your own templates If you need to create your own templates, you can use this generator as a base, and extend it to meet your needs with [Yeoman generator composition](https://yeoman.io/authoring/composability.html). Learn more about creating your own templates in [our documentation](https://aka.ms/bf-create-templates). -### From the command line +### From the command-line -First, install [Yeoman][yeoman] and @microsoft/generator-bot-adaptive using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-adaptive -``` - -Then generate your new project: - -```bash -yo @microsoft/bot-adaptive -botname '{BOT_NAME}' -platform '{dotnet|js}' -integration '{functions|webapp}' -``` - -Once your bot is generated, open your bot with **[Bot Framework Composer][composer]** to edit, manage, and publish your bot, or use your favorite IDE (like Visual Studio) to extend your bot with code. - -## Supported Languages - -- English (en-us) - -## Resource Deployment - -This template contains scaffold code for publishing your bot to either Azure Functions, or Azure Web App. You can also choose to use neither option, and publish to your own web application hosting service of choice. +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License - -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg -[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-adaptive -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ +[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-adaptive \ No newline at end of file diff --git a/generators/generator-bot-command-list/README.md b/generators/generator-bot-command-list/README.md index c84792053..683144da5 100644 --- a/generators/generator-bot-command-list/README.md +++ b/generators/generator-bot-command-list/README.md @@ -1,42 +1,35 @@ # @microsoft/generator-bot-command-list [![NPM version][npm-image]][npm-url] -This template instantiates a bot built around a set of simple commands. Includes cards with message back actions for example commands "hello" and "help." +This template creates a bot built around a set of simple commands. It includes cards with ["message back" actions](https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-actions#messageback) for the commands "hello" and "help." -## Installation +## What this template is for -First, install [Yeoman](http://yeoman.io) and @microsoft/generator-bot-command-list using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)). +Use this template if you want to... -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-command-list -``` - -Then generate your new project: - -```bash -yo @microsoft/bot-command-list '{BOT_NAME}' -``` - -## Packages -Adaptive bots can utilize the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend their base functionality. The following component packages are included: - -- N/A +- Create a bot that relies on cards actions and/or regular expressions. +- Build your bot by composing an ad-hoc set of packages. ## Languages -English. + +- English (en-US) ## Azure Resource Deployment + This template does not rely on any additional Azure Resources. -## Getting To Know Yeoman +## Using this template - * Yeoman has a heart of gold. - * Yeoman is a person with feelings and opinions, but is very easy to work with. - * Yeoman can be too opinionated at times but is easily convinced not to be. - * Feel free to [learn more about Yeoman](http://yeoman.io/). +### From Composer + +From Composer you'll use the **New** button on the **Home** screen to create a new bot. After creation, Composer will guide you through making customizations to your bot. If you'd like to extend your bot with code, you can open up your bot using your favorite IDE (like Visual Studio) from the location you choose during the creation flow. + +### From the command-line + +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -Copyright (c) Microsoft Corporation. All rights reserved. + +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-command-list.svg -[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-command-list +[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-command-list \ No newline at end of file diff --git a/generators/generator-bot-core-assistant/README.md b/generators/generator-bot-core-assistant/README.md index 06142a979..7b6620c8c 100644 --- a/generators/generator-bot-core-assistant/README.md +++ b/generators/generator-bot-core-assistant/README.md @@ -1,6 +1,6 @@ # @microsoft/generator-bot-core-assistant [![NPM version][npm-image]][npm-url] -This template creates an assistant-style conversational bot, with example language models and triggers routing to those dialogs. Assistant-style bots typically help their users accomplish multiple different tasks, and will expect support for more varied conversational interactions. +This template creates an assistant-style conversational bot. Assistant-style bots typically help their users accomplish multiple different tasks, and have support for more varied conversational interactions. Includes support for: @@ -20,17 +20,9 @@ Use this template if you want to... - Create an assistant-style, or advanced conversational bot - See examples of more complex conversational flows, and more advanced language understanding and generation -## Packages - -Your bot can use the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend the base functionality. From Composer, use the Package Manager to discover additional packages you can add to your bot. - -This bot starts with the following packages: - -- [Help and Cancel intent handling](https://www.nuget.org/packages/Microsoft.Bot.Components.HelpAndCancel/) - ## Languages -- English (en-us) +- English (en-US) ## Azure Resource Deployment @@ -48,47 +40,12 @@ From Composer you'll use the **New** button on the **Home** screen to create a n ### From the command-line -First, install [Yeoman][yeoman] and @microsoft/generator-bot-core-assistant using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-core-assistant -``` - -Then generate your new project: - -```bash -yo @microsoft/bot-assistant-core '{BOT_NAME}' -platform '{dotnet|js}' -integration '{functions|webapp}' -``` +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE - -[npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg -[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-core-assistant -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ [luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis +[npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg +[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-core-assistant \ No newline at end of file diff --git a/generators/generator-bot-core-language/README.md b/generators/generator-bot-core-language/README.md index 4f8f74857..f04336b96 100644 --- a/generators/generator-bot-core-language/README.md +++ b/generators/generator-bot-core-language/README.md @@ -1,6 +1,6 @@ # @microsoft/generator-bot-core-language [![NPM version][npm-image]][npm-url] -This template creates a simple conversational bot containing dialogs for the most common conversational flows, with example language models and triggers routing to those dialogs. +This template creates a simple conversational bot, with triggers and dialogs for responding to help, welcome and cancel intents, and a simple response for unknown intents. ## What this template is for @@ -9,18 +9,9 @@ Use this template if you want to... - Create a basic conversational bot with natural language processing (NLP) with a recognizer like [LUIS][luis]. - See the basics of how language understanding, language generation, recognizers and dialogs work together. -## Packages - -Your bot can use the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend the base functionality. From Composer, use the Package Manager to discover additional packages you can add to your bot. - -This bot starts with the following packages: - -- [Help and Cancel intent handling](https://www.nuget.org/packages/Microsoft.Bot.Components.HelpAndCancel/) -- [Welcome dialog](https://www.nuget.org/packages/Microsoft.Bot.Components.Welcome/) - ## Languages -- English (en-us) +- English (en-US) ## Azure Resource Deployment @@ -34,47 +25,12 @@ From Composer you'll use the **New** button on the **Home** screen to create a n ### From the command-line -First, install [Yeoman][yeoman] and @microsoft/generator-bot-core-language using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-core-language -``` - -Then generate your new project: - -```bash -yo @microsoft/bot-conversational-core '{BOT_NAME}' -platform '{dotnet|js}' -integration '{functions|webapp}' -``` +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License - -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) +[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-core-language -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ -[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis diff --git a/generators/generator-bot-core-qna/README.md b/generators/generator-bot-core-qna/README.md index b9167cdef..042f56f94 100644 --- a/generators/generator-bot-core-qna/README.md +++ b/generators/generator-bot-core-qna/README.md @@ -1,6 +1,6 @@ # @microsoft/generator-bot-core-qna [![NPM version][npm-image]][npm-url] -This template creates an empty bot, and guides you through connecting that bot to a QnA Maker knowledge base. You can connect to an existing knowledge base, create one from scratch using .qna files, or create one from an existing FAQ-style website. +This template guides you through creating and connecting a bot to a QnA Maker knowledge base. You can connect to an existing knowledge base, create one from scratch using .qna files, or create one from an existing FAQ-style website. ## What this template is for @@ -14,7 +14,7 @@ Your bot can use the [Azure Bot Framework component model](https://aka.ms/Compon ## Languages -- English (en-us) +- English (en-US) ## Azure Resource Deployment @@ -31,49 +31,12 @@ From Composer you'll use the **New** button on the **Home** screen to create a n ### From the command-line -> You can instantiate this template from the command line, however this approach is NOT recommended, as Composer guides you through connecting to your QnA Maker knowledge base. - -First, install [Yeoman][yeoman] and @microsoft/generator-bot-core-qna using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-core-qna -``` - -Then generate your new project: - -```bash -yo @microsoft/generator-bot-core-qna '{BOT_NAME}' -platform '{dotnet|js}' -integration '{functions|webapp}' -``` +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License - -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) +[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-qna.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-core-qna -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ -[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis diff --git a/generators/generator-bot-empty/README.md b/generators/generator-bot-empty/README.md index 23a4496f9..b370d2261 100644 --- a/generators/generator-bot-empty/README.md +++ b/generators/generator-bot-empty/README.md @@ -1,21 +1,17 @@ # @microsoft/generator-bot-empty [![NPM version][npm-image]][npm-url] -This template creates a bot containing only a root dialog and a initial greeting dialog. +This template creates a bot that sends a simple message when interacted with. ## What this template is for Use this template if you want to... -- Start from scratch, without any extraneous files to delete. +- Start from scratch, with minimal pre-built functionality. - Build your bot by composing an ad-hoc set of packages. -## Packages - -Your bot can use the [Azure Bot Framework component model](https://aka.ms/ComponentTemplateDocumentation) to extend the base functionality. From Composer, use the Package Manager to discover additional packages you can add to your bot. - ## Supported Languages -- English (en-us) +- English (en-US) ## Azure Resource Deployment @@ -29,47 +25,11 @@ From Composer you'll use the **New** button on the **Home** screen to create a n ### From the command-line -This template can also be used from the command-line. First, install [Yeoman][yeoman] and @microsoft/generator-bot-empty using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-empty -``` - -Then generate your new project: - -```bash -yo @microsoft/generator-bot-empty -botname '{BOT_NAME}' -platform '{dotnet|js}' -integration '{functions|webapp}' -``` +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License - -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-empty -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ -[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis diff --git a/generators/generator-bot-enterprise-assistant/README.md b/generators/generator-bot-enterprise-assistant/README.md index d0b0cfff4..1101e2d7b 100644 --- a/generators/generator-bot-enterprise-assistant/README.md +++ b/generators/generator-bot-enterprise-assistant/README.md @@ -33,7 +33,7 @@ This bot starts with the following packages: ## Supported Languages -- English (en-us) +- English (en-US) ## Azure Resource Deployment @@ -59,47 +59,12 @@ From Composer you'll use the **New** button on the **Home** screen to create a n ### From the command-line -First, install [Yeoman][yeoman] and @microsoft/generator-bot-enterprise-assistant using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-enterprise-assistant -``` - -Then generate your new project: - -```bash -yo @microsoft/bot-enterprise-assistant '{BOT_NAME}' -platform 'dotnet' -integration 'webapp' -``` +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License - -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) +[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-enterprise-assistant.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-assistant -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ -[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis diff --git a/generators/generator-bot-enterprise-calendar/README.md b/generators/generator-bot-enterprise-calendar/README.md index cb5f7f4bd..f06674020 100644 --- a/generators/generator-bot-enterprise-calendar/README.md +++ b/generators/generator-bot-enterprise-calendar/README.md @@ -1,4 +1,4 @@ -# @microsoft/generator-bot--enterprise-calendar [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-enterprise-calendar [![NPM version][npm-image]][npm-url] This template creates a bot configured to manage Office 365 calendars using the Microsoft Graph API. @@ -16,7 +16,7 @@ This bot uses the [Azure Bot Framework component model](https://aka.ms/Component ## Supported Languages -- English (en-us) +- English (en-US) ## Azure Resource Deployment @@ -26,7 +26,7 @@ This template requires the following Azure resources: - Contacts.Read - People.Read - User.ReadBasic.All -- Language Understanding (LUIS) authoring resource +- [Language Understanding (LUIS)][luis] authoring resource ## Using this template @@ -36,47 +36,12 @@ From Composer you'll use the **New** button on the **Home** screen to create a n ### From the command-line -This template can also be used from the command-line. First, install [Yeoman][yeoman] and @microsoft/generator-bot-enterprise-calendar using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-enterprise-calendar -``` - -Then generate your new project: - -```bash -yo @microsoft/generator-bot-enterprise-calendar '{BOT_NAME}' -platform 'dotnet' -integration 'webapp' -``` +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License - -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) +[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-calendar -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ -[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis diff --git a/generators/generator-bot-enterprise-people/README.md b/generators/generator-bot-enterprise-people/README.md index 50138c69a..c4c56d92d 100644 --- a/generators/generator-bot-enterprise-people/README.md +++ b/generators/generator-bot-enterprise-people/README.md @@ -16,7 +16,7 @@ This bot uses the [Azure Bot Framework component model](https://aka.ms/Component ## Supported Languages -- English (en-us) +- English (en-US) ## Azure Resource Deployment @@ -28,7 +28,7 @@ This template requires the following Azure resources: - People.Read.All - User.ReadBasic.All - User.Read.All -- Language Understanding (LUIS) authoring resource +- [Language Understanding (LUIS)][luis] authoring resource ## Using this template @@ -38,47 +38,12 @@ From Composer you'll use the **New** button on the **Home** screen to create a n ### From the command-line -This template can also be used from the command-line. First, install [Yeoman][yeoman] and @microsoft/generator-bot-enterprise-people using [npm][npm] (we assume you have pre-installed [node.js][nodejs]): - -```bash -npm install -g yo -npm install -g @microsoft/generator-bot-enterprise-people -``` - -Then generate your new project: - -```bash -yo @microsoft/generator-bot-enterprise-people '{BOT_NAME}' -platform 'dotnet' -integration 'webapp' -``` +This template can also be installed from the [command line](https://github.com/microsoft/botframework-components/blob/main/generators/command-line-instructions). ## License -MIT License - -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE) +[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis [npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people.svg [npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-people -[composer]: https://github.com/microsoft/botframework-composer -[yeoman]: https://yeoman.io -[npm]: https://npmjs.com -[nodejs]: https://nodejs.org/ -[luis]: https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis diff --git a/generators/generator-bot-template-generator/README.md b/generators/generator-bot-template-generator/README.md index 3ec58f962..50fe546d7 100644 --- a/generators/generator-bot-template-generator/README.md +++ b/generators/generator-bot-template-generator/README.md @@ -80,24 +80,10 @@ After making the change, run `yarn build:server` followed by `yarn start:dev`. Y ## License -MIT License +[MIT License][license] -Copyright (c) Microsoft Corporation. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE +[composer]: https://github.com/microsoft/botframework-composer +[yeoman]: https://yeoman.io +[npm]: https://npmjs.com +[nodejs]: https://nodejs.org/ +[license]: https://github.com/microsoft/botframework-components/blob/main/LICENSE diff --git a/packages/AdaptiveCards/Microsoft.Bot.Components.AdaptiveCards.csproj b/packages/AdaptiveCards/Microsoft.Bot.Components.AdaptiveCards.csproj index 839031be6..3f1d814de 100644 --- a/packages/AdaptiveCards/Microsoft.Bot.Components.AdaptiveCards.csproj +++ b/packages/AdaptiveCards/Microsoft.Bot.Components.AdaptiveCards.csproj @@ -30,6 +30,7 @@ + diff --git a/packages/AdaptiveCards/README.md b/packages/AdaptiveCards/README.md new file mode 100644 index 000000000..0fb121e9e --- /dev/null +++ b/packages/AdaptiveCards/README.md @@ -0,0 +1,20 @@ +# Microsoft.Bot.Components.AdaptiveCards + +Actions and triggers for working with the Adaptive Cards from your Bot Framework bot. This package contains: + +- Actions for creating, storing, and sending Adaptive Cards +- Triggers for responding to [Adaptive Cards invokes & activities](https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-actions#adaptive-cards-actions), like Action.Submit, Action.Execute + +## Getting started + +Once you've installed the package using [Bot Framework Composer](https://docs.microsoft.com/composer), you can add our actions and triggers to your bot. + +Use the [Adaptive Card designer](https://adaptivecards.io/designer/) to create and preview your cards. + +## Learn more + +Learn more about [creating Adaptive Cards](https://adaptivecards.io/). + +## Feedback and issues + +If you encounter any issues with this package, or would like to share any feedback please open an Issue in our [GitHub repository](https://github.com/microsoft/botframework-components/issues/new/choose). diff --git a/packages/Teams/Microsoft.Bot.Components.Teams.csproj b/packages/Teams/Microsoft.Bot.Components.Teams.csproj index ca373d280..c5b11bae5 100644 --- a/packages/Teams/Microsoft.Bot.Components.Teams.csproj +++ b/packages/Teams/Microsoft.Bot.Components.Teams.csproj @@ -31,6 +31,7 @@ + diff --git a/packages/Teams/README.md b/packages/Teams/README.md new file mode 100644 index 000000000..7394c558d --- /dev/null +++ b/packages/Teams/README.md @@ -0,0 +1,21 @@ +# Microsoft.Bot.Components.Teams + +Actions and triggers for working with the Microsoft Teams channel from your Bot Framework bot. This package contains: + +- Triggers for responding to Microsoft Teams specific events, like Messaging Extensions, Task Modules, and other invokes. +- Actions for sending Teams-specific activities. +- Actions for calling Teams-specific APIs to get additional context and information for your bot. + +## Getting started + +Once you've installed the package using [Bot Framework Composer](https://docs.microsoft.com/composer), you can add our actions and triggers to your bot. + +Make sure you've enabled the connection to Microsoft Teams in the `Connections` tab of your `Project Settings` in Composer. + +## Learn more + +Learn more about [creating bots for Microsoft Teams](https://docs.microsoft.com/microsoftteams/platform/bots/what-are-bots). + +## Feedback and issues + +If you encounter any issues with this package, or would like to share any feedback please open an Issue in our [GitHub repository](https://github.com/microsoft/botframework-components/issues/new/choose).