Commit for readme updated.

JhontSouth · Oct 18, 2022 · c8b49be · c8b49be
1 parent ea0f755
commit c8b49be
Show file tree

Hide file tree

Showing 21 changed files with 365 additions and 23,297 deletions.
diff --git a/samples/app-checkin-location/csharp/AppCheckinLocation/Images/ViewLocation.png b/samples/app-checkin-location/csharp/AppCheckinLocation/Images/ViewLocation.png
diff --git a/samples/app-checkin-location/csharp/README.md b/samples/app-checkin-location/csharp/README.md
@@ -19,7 +19,7 @@ This sample shows feature where user can checkin with current location and view
 
 `Currently, Microsoft Teams support for get geolocation capability is only available for mobile clients`
 
-# Key features
+## Interaction with bot
 
 ![App checkin LocationGif](AppCheckinLocation/Images/AppcheckinLocationGif.gif)
 
@@ -39,7 +39,7 @@ This sample shows feature where user can checkin with current location and view
   ```
 - [Teams](https://teams.microsoft.com) Microsoft Teams is installed and you have an account
 
-## To try this sample
+## Setup
 
 1) Create a Bot Registration
    In Azure portal, create a [Bot Framework registration resource](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-authentication?view=azure-bot-service-4.0&tabs=csharp%2Caadv2).
@@ -99,24 +99,26 @@ This sample shows feature where user can checkin with current location and view
    - Go to your project directory, the ./AppPackage folder, select the zip folder, and choose Open.
    - Select Add in the pop-up dialog box. Your app is uploaded to Teams.
 
-## Features of this sample
-
-- Card with actions `check in`. 
+## Running the sample
 
+**Card with actions check in:**
 ![Check in card](AppCheckinLocation/Images/CheckinCard.png)
 
-- `Geo Location` of user.
-
+**Geo Location of user:**
 ![Geo Location](AppCheckinLocation/Images/GeoLocation.png)
 
-- User details.
-
+**User details:**
 ![User details card](AppCheckinLocation/Images/UserDetailsCard.png)
 
-- `viewcheckindetails` of user.
-
+**Viewcheckin Details of user:**
 ![User last checkin card](AppCheckinLocation/Images/UserLastCheckInCard.png)
 
+**Geo Location of user:**
+![Geo Location](AppCheckinLocation/Images/GeoLocation.png)
+
+**View Location UI:**
+![View Location](AppCheckinLocation/Images/ViewLocation.png)
+
 ## Deploy the bot to Azure
 
 To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](https://aka.ms/azuredeployment) for a complete list of deployment instructions.

diff --git a/samples/app-checkin-location/nodejs/Images/ViewLocation.png b/samples/app-checkin-location/nodejs/Images/ViewLocation.png
diff --git a/samples/app-checkin-location/nodejs/Readme.md b/samples/app-checkin-location/nodejs/Readme.md
@@ -18,19 +18,19 @@ This sample shows feature where user can checkin with current location and view
 
 `Currently, Microsoft Teams support for get geolocation capability is only available for mobile clients`
 
-# Key features
+- Interaction with bot
 
 ![App checkin LocationGif](Images/AppcheckinLocationGif.gif)
 
 ## Prerequisites
 
 - Microsoft Teams is installed and you have an account (not a guest account)
--  [NodeJS](https://nodejs.org/en/)
--  [ngrok](https://ngrok.com/) or equivalent tunneling solution
--  [M365 developer account](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/prepare-your-o365-tenant) or access to a Teams account with the 
+- To test locally, [NodeJS](https://nodejs.org/en/download/) must be installed on your development machine (version 16.14.2  or higher)
+- [ngrok](https://ngrok.com/) or equivalent tunneling solution
+- [M365 developer account](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/prepare-your-o365-tenant) or access to a Teams account with the 
    appropriate permissions to install an app.
 
-## To try this sample
+## Setup
 
 > Note these instructions are for running the sample on your local machine, the tunnelling solution is required because
 > the Teams service needs to call into the bot.
@@ -73,23 +73,22 @@ In Azure portal, create a [Azure Bot resource](https://docs.microsoft.com/en-us/
     - Zip up the contents of the `appPackage/` folder to create a `manifest.zip`
     - Upload the `manifest.zip` to Teams (in the left-bottom *Apps* view, click "Upload a custom app")
 
-## Features of this sample
-
-- Card with actions `check in`. 
+## Running the sample
 
+**Card with actions check in:**
 ![Check in card](Images/CheckinCard.png)
 
-- `Geo Location` of user.
-
+**Geo Location of user:**
 ![Geo Location](Images/GeoLocation.png)
 
-- User details.
-
+**User details:**
 ![User details card](Images/UserDetailsCard.png)
 
-- `viewcheckindetails` of user.
-
+**Viewcheckin Details of user:**
 ![User last checkin card](Images/UserLastCheckInCard.png)
 
+**View Location UI:**
+![View Location](Images/ViewLocation.png)
+
 
 
diff --git a/samples/app-installation-using-qr-code/csharp/README.md b/samples/app-installation-using-qr-code/csharp/README.md
@@ -21,42 +21,14 @@ The user can Generate a new QR code (contains app id information) and then use I
 
 `Currently, Microsoft Teams support for QR or barcode scanner capability is only available for mobile clients`.
 
-# Feature of the sample - Desktop View
+## Interaction with bot - Desktop View
 
 ![App Installation Using QRCodeDesktopGif](QRAppInstallation/Images/AppInstallationUsingQRCodeDesktopGif.gif)
 
-# Feature of the sample - Mobile View
+## Interaction with bot - Mobile View
 
 ![App Installation Using QRCodeGif](QRAppInstallation/Images/AppInstallationUsingQRCodeGif.gif)
 
-## Desktop View
-
-- Card with actions `Generate QR code` and `Install App`. 
-
-![Card](QRAppInstallation/Images/CardWithButtons.png)
-
-- `Generate QR code` is used to generate a QR code by selecting the app.
-
-![QR Code](QRAppInstallation/Images/QRCode.png)
-
-- `Install App` is used to Scan the QR code and it then installs the app.
-
-![Install App](QRAppInstallation/Images/AppInstallation.png)
-
-## Mobile View
-
-![CardWithButtonsMobile](QRAppInstallation/Images/CardWithButtonsMobile.png)
-
-- `Permission App` Also add following permission
-
-![Permission](QRAppInstallation/Images/Permission.png)
-
-![QRCodeMobile](QRAppInstallation/Images/QRCodeMobile.png)
-
-![AppAddedMobile](QRAppInstallation/Images/AppAddedMobile.png)
-
-![AppInstallationMobile](QRAppInstallation/Images/AppInstallationMobile.png)
-
 ## Prerequisites
 
 - [.NET Core SDK](https://dotnet.microsoft.com/download) version 3.1
@@ -73,7 +45,7 @@ The user can Generate a new QR code (contains app id information) and then use I
   ```
 - [Teams](https://teams.microsoft.com) Microsoft Teams is installed and you have an account
 
-## To try this sample
+## Setup
 
 1) Create a Bot Registration
    In Azure portal, create a [Bot Framework registration resource](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-authentication?view=azure-bot-service-4.0&tabs=csharp%2Caadv2).
@@ -134,6 +106,35 @@ The user can Generate a new QR code (contains app id information) and then use I
    - Go to your project directory, the ./AppPackage folder, select the zip folder, and choose Open.
    - Select Add in the pop-up dialog box. Your app is uploaded to Teams.
 
+## Running the sample
+
+- Desktop View
+**Card with actions Generate QR code and Install App:**
+![Card](QRAppInstallation/Images/CardWithButtons.png)
+
+**Generate QR code is used to generate a QR code by selecting the app:**
+![QR Code](QRAppInstallation/Images/QRCode.png)
+
+**Install App is used to Scan the QR code and it then installs the app:**
+![Install App](QRAppInstallation/Images/AppInstallation.png)
+
+
+-  Mobile View
+**Hey command interaction:**
+![CardWithButtonsMobile](QRAppInstallation/Images/CardWithButtonsMobile.png)
+
+**Permission App Also add following permission:**
+![Permission](QRAppInstallation/Images/Permission.png)
+
+**QR Code:**
+![QRCodeMobile](QRAppInstallation/Images/QRCodeMobile.png)
+
+**App added:**
+![AppAddedMobile](QRAppInstallation/Images/AppAddedMobile.png)
+
+**Polly App Install:**
+![AppInstallationMobile](QRAppInstallation/Images/AppInstallationMobile.png)
+
 ## Deploy the bot to Azure
 
 To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](https://aka.ms/azuredeployment) for a complete list of deployment instructions.

diff --git a/samples/app-installation-using-qr-code/nodejs/Readme.md b/samples/app-installation-using-qr-code/nodejs/Readme.md
@@ -21,51 +21,23 @@ The user can Generate a new QR code (contains app id information) and then use I
 
 `Currently, Microsoft Teams support for QR or barcode scanner capability is only available for mobile clients`
 
-# Feature of the sample - Desktop View
+## Interaction with bot - Desktop View
 
 ![App Installation Using QRCodeDesktopGif](Images/AppInstallationUsingQRCodeDesktopGif.gif)
 
-# Feature of the sample - Mobile View
+## Interaction with bot - Mobile View
 
 ![App Installation Using QRCodeGif](Images/AppInstallationUsingQRCodeGif.gif)
 
-## Desktop View
-
-- Card with actions `Generate QR code` and `Install App`. 
-
-![Card](Images/CardWithButtons.png)
-
-- `Generate QR code` is used to generate a QR code by selecting the app.
-
-![QR Code](Images/QRCode.png)
-
-- `Install App` is used to Scan the QR code and it then installs the app.
-
-![Install App](Images/AppInstallation.png)
-
-## Mobile View 
-
-![CardWithButtonsMobile](Images/CardWithButtonsMobile.png)
-
-- `Permission App`  Add the following permission
-
-![Install App](Images/Permission.png)
-
-![QRCodeMobile](Images/QRCodeMobile.png)
-
-![AppAddedMobile](Images/AppAddedMobile.png)
-
-![AppInstallationMobile](Images/AppInstallationMobile.png)
-
 ## Prerequisites
 
 - Microsoft Teams is installed and you have an account (not a guest account)
--  [NodeJS](https://nodejs.org/en/)
+-  To test locally, [NodeJS](https://nodejs.org/en/download/) must be installed on your development machine (version 16.14.2  or higher)
 -  [ngrok](https://ngrok.com/) or equivalent tunneling solution
 -  [M365 developer account](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/prepare-your-o365-tenant) or access to a Teams account with the 
    appropriate permissions to install an app.
 
-## To try this sample
+## Setup
 
 > Note these instructions are for running the sample on your local machine, the tunnelling solution is required because
 > the Teams service needs to call into the bot.
@@ -75,8 +47,6 @@ In Azure portal, create a [Bot Framework registration resource](https://docs.mic
 
 - Ensure that you've [enabled the Teams Channel](https://docs.microsoft.com/en-us/azure/bot-service/channel-connect-teams?view=azure-bot-service-4.0)
 
-
-
 ### 2. Run your bot sample
 1) Clone the repository
 
@@ -109,4 +79,50 @@ In Azure portal, create a [Bot Framework registration resource](https://docs.mic
     - Zip up the contents of the `appPackage/` folder to create a `manifest.zip`
     - Upload the `manifest.zip` to Teams (in the left-bottom *Apps* view, click "Upload a custom app")
 
-    > IMPORTANT: The manifest file in this app adds "token.botframework.com" to the list of `validDomains`. This must be included in any bot that uses the Bot Framework OAuth flow.
+    > IMPORTANT: The manifest file in this app adds "token.botframework.com" to the list of `validDomains`. This must be included in any bot that uses the Bot Framework OAuth flow.
+
+## Running the sample
+
+- Desktop View
+**Card with actions Generate QR code and Install App:**
+![Card](Images/CardWithButtons.png)
+
+**Generate QR code is used to generate a QR code by selecting the app:**
+![QR Code](Images/QRCode.png)
+
+**Install App is used to Scan the QR code and it then installs the app:**
+![Install App](Images/AppInstallation.png)
+
+
+-  Mobile View
+**Hey command interaction:**
+![CardWithButtonsMobile](Images/CardWithButtonsMobile.png)
+
+**Permission App Also add following permission:**
+![Install App](Images/Permission.png)
+
+**QR Code:**
+![QRCodeMobile](Images/QRCodeMobile.png)
+
+**App added:**
+![AppAddedMobile](Images/AppAddedMobile.png)
+
+**Polly App Install:**
+![AppInstallationMobile](Images/AppInstallationMobile.png)
+
+## Deploy the bot to Azure
+
+To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](https://aka.ms/azuredeployment) for a complete list of deployment instructions.
+
+## Further reading
+
+- [Bot Framework Documentation](https://docs.botframework.com)
+- [Bot Basics](https://docs.microsoft.com/azure/bot-service/bot-builder-basics?view=azure-bot-service-4.0)
+- [Activity processing](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-concept-activity-processing?view=azure-bot-service-4.0)
+- [Azure Bot Service Introduction](https://docs.microsoft.com/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0)
+- [Azure Bot Service Documentation](https://docs.microsoft.com/azure/bot-service/?view=azure-bot-service-4.0)
+- [.NET Core CLI tools](https://docs.microsoft.com/en-us/dotnet/core/tools/?tabs=netcore2x)
+- [Azure CLI](https://docs.microsoft.com/cli/azure/?view=azure-cli-latest)
+- [Azure Portal](https://portal.azure.com)
+- [Language Understanding using LUIS](https://docs.microsoft.com/en-us/azure/cognitive-services/luis/)
+- [Channels and Bot Connector Service](https://docs.microsoft.com/en-us/azure/bot-service/bot-concepts?view=azure-bot-service-4.0)
diff --git a/samples/bot-archive-groupchat-messages/nodejs/README.md b/samples/bot-archive-groupchat-messages/nodejs/README.md
@@ -19,20 +19,18 @@ Using this nodejs sample, a bot can archive chat messages of groupchat and send
 
 This feature shown in this sample is currently available in Public Developer Preview only.
 
-## Key features
-
-- Sending archive chat messages text file of a groupchat to user
+## Interaction with bot
 
 ![Bot Archive Group ChatMessagesGif](Images/botArchiveGroupchatMessagesGif.gif)
 
 ## Prerequisites
 
-- Microsoft Teams is installed and you have an account (not a guest account)
--  [NodeJS](https://nodejs.org/en/)
+-  Microsoft Teams is installed and you have an account (not a guest account)
+-  To test locally, [NodeJS](https://nodejs.org/en/download/) must be installed on your development machine (version 16.14.2  or higher)
 -  [ngrok](https://ngrok.com/) or equivalent tunneling solution
 -  [M365 developer account](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/prepare-your-o365-tenant) or access to a Teams account with the appropriate permissions to install an app.
 
-## To try this sample
+## Setup
 
 > Note these instructions are for running the sample on your local machine, the tunnelling solution is required because
 > the Teams service needs to call into the bot.
@@ -108,16 +106,24 @@ In Azure portal, create a [Bot Framework registration resource](https://docs.mic
 
     > IMPORTANT: The manifest file in this app adds "token.botframework.com" to the list of `validDomains`. This must be included in any bot that uses the Bot Framework OAuth flow.
 
+## Running the sample
+
+**Login command interaction:**
 ![Bot Welcome](Images/welcome.png)
 
+**Login successful:**
 ![Bot LoginSuccessful](Images/loginsuccessful.png)
 
+**Set up a bot:**
 ![Bot Setupbot](Images/setupbot.png)
 
+**Getchat command interaction:**
 ![Bot BotCommandToGetChatMessages](Images/botCommandToGetChatMessages.png)
 
+**Bot is added to fetch messages:**
 ![Bot Getchat](Images/getchat.png)
 
+**Ready to download:**
 ![Bot ReplyFromBot](Images/replyFromBot.png)
 
 ## Interacting with the bot in GroupChat
@@ -126,3 +132,16 @@ Select a groupchat and add the bot to chat.
 
 Send `getchat` message to the bot, you will recieve a consent card by the bot in your personal scope.
 
+## Interacting with the bot in GroupChat
+
+Select a groupchat and add the bot to chat.
+
+Send `getchat` message to the bot, you will recieve a consent card by the bot in your personal scope.
+
+
+## Deploy the bot to Azure
+
+To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](https://aka.ms/azuredeployment) for a complete list of deployment instructions.
+
+
+