Merge pull request #27 from BotBuilderCommunity/v1

Merge v1
BotBuilderCommunity · Aug 11, 2019 · 08ba13d · 08ba13d
2 parents a82ae87 + 5727833
commit 08ba13d
Show file tree

Hide file tree

Showing 16 changed files with 1,726 additions and 262 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,6 +1,5 @@
 **/node_modules/**
 
-libraries/botbuilder-adapters/**/*
 libraries/botbuilder-dialog-prompts/**/*
 libraries/botbuilder-spell-check-middleware/**/*
 libraries/botbuilder-storage/**/*

diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ The following adapters can be used to expose your bot on additional channels not
 
 | Name | Description | NPM |
 | ---- | ----------- | ------- |
-| [@botbuildercommunity/adapters](libraries/botbuilder-adapters/README.md) | Alternative platform adapters | [![NPM Version](https://img.shields.io/npm/v/@botbuildercommunity/adapters.svg)](https://www.npmjs.com/package/@botbuildercommunity/adapters) |
+| [@botbuildercommunity/adapter-console](libraries/botbuilder-adapter-console/README.md) | A platform adapter for the console / terminal | [![NPM Version](https://img.shields.io/npm/v/@botbuildercommunity/adapter-console.svg)](https://www.npmjs.com/package/@botbuildercommunity/adapter-console) |
 | [@botbuildercommunity/adapter-twilio-whatsapp](libraries/botbuilder-adapter-twilio-whatsapp/README.md) | A platform adapter for Twilio WhatsApp | [![NPM Version](https://img.shields.io/npm/v/@botbuildercommunity/adapter-twilio-whatsapp.svg)](https://www.npmjs.com/package/@botbuildercommunity/adapter-twilio-whatsapp) |
 
 The following packages are available from [Botkit](https://github.com/howdyai/botkit), and work with both the Bot Framework and Botkit:
@@ -63,4 +63,4 @@ The following packages are available from [Botkit](https://github.com/howdyai/bo
 | [botbuilder-adapter-webex](https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-webex#readme) | A platform adapter for Webex Teams| ![NPM Version](https://img.shields.io/npm/v/botbuilder-adapter-webex.svg)
 | [botbuilder-adapter-hangouts](https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-hangouts#readme) | A platform adapter for Google | ![NPM Version](https://img.shields.io/npm/v/botbuilder-adapter-hangouts.svg)
 | [botbuilder-adapter-twilio-sms](https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-twilio-sms#readme) | A platform adapter for Twilio SMS | ![NPM Version](https://img.shields.io/npm/v/botbuilder-adapter-twilio-sms.svg)
-| [botbuilder-adapter-facebook](https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-facebook#readme) | A platform adapter for Facebook Messenger | ![NPM Version](https://img.shields.io/npm/v/botbuilder-adapter-facebook.svg)
+| [botbuilder-adapter-facebook](https://github.com/howdyai/botkit/tree/master/packages/botbuilder-adapter-facebook#readme) | A platform adapter for Facebook Messenger | ![NPM Version](https://img.shields.io/npm/v/botbuilder-adapter-facebook.svg)
diff --git a/libraries/botbuilder-adapter-console/.gitignore b/libraries/botbuilder-adapter-console/.gitignore
@@ -0,0 +1,3 @@
+/lib
+/node_modules
+/.vscode
diff --git a/libraries/botbuilder-adapter-console/CHANGELOG.md b/libraries/botbuilder-adapter-console/CHANGELOG.md
@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2019-??-??
+### Added
+- First release of Console adapter
diff --git a/libraries/botbuilder-adapter-console/README.md b/libraries/botbuilder-adapter-console/README.md
@@ -0,0 +1,27 @@
+# Console Adapter
+The console adapter lets you create a chatbot that works from the command line. This was built-in functionality in SDK v3, but was absent from the SDK v4 library. The console bot is limited in which functionality it can implement from the base adapter.
+
+## Installation
+To install:
+
+    npm install @botbuildercommunity/adapter-console --save
+
+## Usage
+Include it in your bot:
+
+```typescript
+import { ConsoleAdapter } from "@botbuildercommunity/adapter-console";
+```
+Create the adapter:
+```typescript
+const adapter: ConsoleAdapter = new ConsoleAdapter();
+```
+
+Listen for activities:
+```typescript
+adapter.processActivity(async (context: TurnContext) => {
+    ...
+});
+```
+
+From there you can pass the `context` to your bot logic's `onTurn()` method.