Permalink
Browse files

readme update

  • Loading branch information...
Vishwac Sena Kannan
Vishwac Sena Kannan committed Sep 22, 2018
1 parent f585ae7 commit 0b15817dc29078eb0a1f5d45753eabf4f77cb6b0
Showing with 23 additions and 18 deletions.
  1. +23 −18 README.md
View
@@ -1,13 +1,12 @@
# Microsoft Bot Framework Emulator (V4 PREVIEW)
# Microsoft Bot Framework Emulator (V4 PREVIEW)
[![Build Status](https://travis-ci.org/Microsoft/BotFramework-Emulator.svg?branch=v4)](https://travis-ci.org/Microsoft/BotFramework-Emulator) [![Coverage Status](https://coveralls.io/repos/github/Microsoft/BotFramework-Emulator/badge.svg?branch=v4)](https://coveralls.io/github/Microsoft/BotFramework-Emulator?branch=v4)
The [Microsoft Bot Framework](https://botframework.com) is a service and [SDK](https://github.com/Microsoft/BotBuilder) that enables organizations to build and deploy intelligent agents, known as bots.
The Bot Framework Emulator is a desktop application that allows bot developers to test and debug bots built using the [BotBuilder SDK](https://github.com/microsoft/botbuilder).
The Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
You can use the Bot Framework Emulator to test bots running either locally on your machine or connect to bots running remotely through a tunnel.
## Download
* From the [Bot Framework](https://emulator.botframework.com) site
* From the [GitHub releases](https://github.com/Microsoft/BotFramework-Emulator/releases) page
### Supported platforms
@@ -16,20 +15,9 @@ The Bot Framework Emulator is a desktop application that allows bot developers t
* OS X
* Linux
## Getting Started
## Documentation
The Bot Framework Emulator can communicate with your bot wherever it is running; on localhost, or remotely in the cloud.
* [Connect to a bot running locally](https://github.com/Microsoft/BotFramework-Emulator/wiki/Getting-Started#connect-to-a-bot-running-on-localhost)
* [Connect to a bot hosted remotely](https://github.com/Microsoft/BotFramework-Emulator/wiki/Getting-Started#connect-to-a-bot-hosted-remotely)
* [Connect to an Azure Bot Service](https://github.com/Microsoft/BotFramework-Emulator/wiki/Getting-Started#connect-to-an-azure-bot-service)
## Contributing
If you are interested in fixing issues and contributing directly to the code base, please see [How to Contribute](https://github.com/Microsoft/BotFramework-Emulator/blob/v4/CONTRIBUTING.md), which covers the following:
* [How to build and run from source](https://github.com/Microsoft/BotFramework-Emulator/blob/v4/CONTRIBUTING.md#how-to-build-from-source)
* [Submitting pull requests](https://github.com/Microsoft/BotFramework-Emulator/blob/v4/CONTRIBUTING.md#pull-requests)
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
Checkout the [Wiki](https://github.com/Microsoft/BotFramework-Emulator/wiki) for docs.
## Feedback
@@ -43,8 +31,25 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
* [BotBuilder Tools](https://github.com/Microsoft/BotBuilder-Tools)
* [BotFramework-WebChat](https://github.com/Microsoft/BotFramework-WebChat)
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Reporting Security Issues
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [secure@microsoft.com](mailto:secure@microsoft.com). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/default).
## License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the [MIT](LICENSE.txt) License.
Licensed under the [MIT](LICENSE) License.

0 comments on commit 0b15817

Please sign in to comment.