diff --git a/generators/command-line-instructions.md b/generators/command-line-instructions.md index 0a1b3a60f4..d760a1ff67 100644 --- a/generators/command-line-instructions.md +++ b/generators/command-line-instructions.md @@ -1,6 +1,6 @@ # 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]): +Our templates can also be used from the command-line. First, install [Yeoman](https://yeoman.io) using [npm](https://npmjs.com) (we assume you have pre-installed [node.js](https://nodejs.org/)): ```bash npm install -g yo @@ -17,13 +17,13 @@ Next, identify the template you would like to use from the table below: | [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: +Once you have identified the template you would like to use, install it using [npm](https://npmjs.com). 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: +Finally, generate your new project using [Yeoman](https://yeoman.io), 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. @@ -33,7 +33,3 @@ Finally, generate your new project using [Yeoman][yeoman], taking note of the fo ```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 0a2b5e5ba9..18c3126a23 100644 --- a/generators/generator-bot-adaptive/README.md +++ b/generators/generator-bot-adaptive/README.md @@ -1,4 +1,4 @@ -# @microsoft/generator-bot-adaptive [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-adaptive [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-adaptive) 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: @@ -28,6 +28,3 @@ This template can also be installed from the [command line](https://github.com/m ## License [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 \ 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 c8164eb085..fa9b311d1e 100644 --- a/generators/generator-bot-core-assistant/README.md +++ b/generators/generator-bot-core-assistant/README.md @@ -1,4 +1,4 @@ -# @microsoft/generator-bot-core-assistant [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-core-assistant [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-assistant.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-core-assistant) A bot with Azure Language Understanding (LUIS) and common trigger phrases used to direct the conversation flow and help customers accomplish basic tasks. @@ -20,7 +20,7 @@ A bot with Azure Language Understanding (LUIS) and common trigger phrases used t ### Required Azure resources -- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure Language Understanding (LUIS)](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis), or another recognizer of your choice - [Azure QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) - A storage solution for persistent state storage like Azure Cosmos DB @@ -31,7 +31,3 @@ A bot with Azure Language Understanding (LUIS) and common trigger phrases used t ### License [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-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 ec96ca5fd3..3ab1cba06b 100644 --- a/generators/generator-bot-core-language/README.md +++ b/generators/generator-bot-core-language/README.md @@ -1,10 +1,10 @@ -# @microsoft/generator-bot-core-language [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-core-language [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-language.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-core-language) A simple bot with Azure Language Understanding (LUIS) and common trigger phrases used to direct the conversation flow. ### Recommended use -- Create a simple conversational bot with Azure Language Understanding ([LUIS][luis]) +- Create a simple conversational bot with Azure Language Understanding ([LUIS](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis)) - Customize and extend example dialogs, bot logic, language understanding and bot responses - Extend your bot with [Azure Bot Framework components](https://aka.ms/ComponentTemplateDocumentation) @@ -14,11 +14,11 @@ A simple bot with Azure Language Understanding (LUIS) and common trigger phrases - Asking for help - Responding to unknown language requests (unknown intents) - Cancelling a dialog -- Use Azure Language Understanding Service (LUIS) for natural language processing +- Use Azure Language Understanding Service ([LUIS](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis)) for natural language processing ### Required Azure resources -- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure Language Understanding (LUIS)](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis), or another recognizer of your choice - A storage solution for persistent state storage like Azure Cosmos DB ### Supported languages @@ -28,7 +28,3 @@ A simple bot with Azure Language Understanding (LUIS) and common trigger phrases ### License [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 diff --git a/generators/generator-bot-core-qna/README.md b/generators/generator-bot-core-qna/README.md index 5dd28d5854..3af6b3ed55 100644 --- a/generators/generator-bot-core-qna/README.md +++ b/generators/generator-bot-core-qna/README.md @@ -1,4 +1,4 @@ -# @microsoft/generator-bot-core-qna [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-core-qna [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-core-qna.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-core-qna) A simple question-and-answer bot with Azure QnA Maker. @@ -14,7 +14,7 @@ A simple question-and-answer bot with Azure QnA Maker. ### Required Azure resources -- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure Language Understanding (LUIS)](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis), or another recognizer of your choice - [Azure QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) ### Supported languages @@ -24,7 +24,3 @@ A simple question-and-answer bot with Azure QnA Maker. ### License [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 diff --git a/generators/generator-bot-empty/README.md b/generators/generator-bot-empty/README.md index 1d70a2c074..69459c6934 100644 --- a/generators/generator-bot-empty/README.md +++ b/generators/generator-bot-empty/README.md @@ -1,4 +1,4 @@ -# @microsoft/generator-bot-empty [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-empty [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-empty.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-empty) A simple bot with a root dialog and greeting dialog. @@ -22,7 +22,3 @@ A simple bot with a root dialog and greeting dialog. ### License [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-empty.svg -[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-empty diff --git a/generators/generator-bot-enterprise-assistant/README.md b/generators/generator-bot-enterprise-assistant/README.md index 4623bca93d..22ef0d379d 100644 --- a/generators/generator-bot-enterprise-assistant/README.md +++ b/generators/generator-bot-enterprise-assistant/README.md @@ -1,4 +1,4 @@ -# @microsoft/generator-bot-enterprise-assistant [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-enterprise-assistant [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-assistant.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-assistant) A bot with Azure Language Understanding (LUIS), Enterprise Calendar skill, Enterprise People skill and common trigger phrases used to direct the conversation flow to help customers accomplish common business tasks. [Learn more](https://aka.ms/EnterpriseAssistant) @@ -39,7 +39,7 @@ The Enterprise Assistant Bot uses packages to extend its capabilities. [Learn mo - People.Read.All - User.ReadBasic.All - User.Read.All -- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure Language Understanding (LUIS)](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis), or another recognizer of your choice - [Azure QnA Maker](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview) - A storage solution for persistent state storage like Azure Cosmos DB @@ -51,6 +51,3 @@ The Enterprise Assistant Bot uses packages to extend its capabilities. [Learn mo [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-assistant.svg -[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-assistant diff --git a/generators/generator-bot-enterprise-calendar/README.md b/generators/generator-bot-enterprise-calendar/README.md index b6b5581863..d87120e963 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](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-calendar.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-calendar) This bot project was created using the [Enterprise Calendar Bot](https://aka.ms/EnterpriseCalendarBot) template. You **must complete the configuration steps outlined below for your bot to function.** @@ -24,7 +24,7 @@ The Enterprise Calendar Bot uses packages to extend its capabilities. [Learn mor - Contacts.Read - People.Read - User.ReadBasic.All -- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure Language Understanding (LUIS)](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis), or another recognizer of your choice ### Supported languages @@ -33,7 +33,3 @@ The Enterprise Calendar Bot uses packages to extend its capabilities. [Learn mor ### License [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 diff --git a/generators/generator-bot-enterprise-people/README.md b/generators/generator-bot-enterprise-people/README.md index 2f76a38120..ade1381168 100644 --- a/generators/generator-bot-enterprise-people/README.md +++ b/generators/generator-bot-enterprise-people/README.md @@ -1,4 +1,4 @@ -# @microsoft/generator-bot-enterprise-people [![NPM version][npm-image]][npm-url] +# @microsoft/generator-bot-enterprise-people [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-enterprise-people.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-enterprise-people) A bot with the ability to interact with Office 365 users in an Azure Active Directory using Microsoft Graph. [Learn more](https://aka.ms/EnterprisePeopleBot) @@ -26,7 +26,7 @@ The Enterprise People Bot uses packages to extend its capabilities. [Learn more] - People.Read.All - User.ReadBasic.All - User.Read.All -- [Azure Language Understanding (LUIS)][luis], or another recognizer of your choice +- [Azure Language Understanding (LUIS)](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/what-is-luis), or another recognizer of your choice ### Supported languages @@ -36,6 +36,3 @@ The Enterprise People Bot uses packages to extend its capabilities. [Learn more] [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 diff --git a/generators/generator-bot-template-generator/README.md b/generators/generator-bot-template-generator/README.md index 29dce62c2b..3139342db6 100644 --- a/generators/generator-bot-template-generator/README.md +++ b/generators/generator-bot-template-generator/README.md @@ -1,4 +1,4 @@ -# bot-template-generator [![NPM version][npm-image]][npm-url] +# bot-template-generator [![NPM version](https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg)](https://www.npmjs.com/package/@microsoft/generator-bot-adaptive) Yeoman generator generating a bot template generator for use with the Microsoft Bot Framework. @@ -80,13 +80,5 @@ After making the change, run `yarn build:server` followed by `yarn start:dev`. Y ## License -[MIT License][license] - -[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 -[npm-image]: https://badge.fury.io/js/%40microsoft%2Fgenerator-bot-adaptive.svg -[npm-url]: https://www.npmjs.com/package/@microsoft/generator-bot-adaptive +[MIT License](https://github.com/microsoft/botframework-components/blob/main/LICENSE)