Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

Commit 94ffbaa

Browse files
authoredMay 3, 2019
Update readme.md
1 parent cd9e589 commit 94ffbaa

File tree

1 file changed

+25
-55
lines changed

1 file changed

+25
-55
lines changed
 

‎readme.md

+25-55
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,8 @@
1-
# [Botkit](https://botkit.ai) - Building Blocks for Building Bots
1+
# Botkit Legacy Version
22

3-
[![npm](https://img.shields.io/npm/v/botkit.svg)](https://www.npmjs.com/package/botkit)
4-
[![David](https://img.shields.io/david/howdyai/botkit.svg)](https://david-dm.org/howdyai/botkit)
5-
[![npm](https://img.shields.io/npm/l/botkit.svg)](https://spdx.org/licenses/MIT)
6-
[![Build Status](https://travis-ci.com/howdyai/botkit.svg?branch=master)](https://travis-ci.com/howdyai/botkit)
3+
This is the maintenance branch for the legacy version of Botkit (< 0.7.4).
74

8-
**Botkit is the leading developer tool for building chat bots, apps and custom integrations for major messaging platforms.**
9-
10-
Botkit offers everything you need to design, build and operate an app:
11-
12-
* Easy-to-extend starter kits
13-
* Fully-featured SDK with support for all major platforms
14-
* [Tons of plugins and middlewares](https://botkit.ai/docs/readme-middlewares.html)
15-
16-
Plus, Botkit works with all the NLP services (like Microsoft LUIS and IBM Watson), can use any type of database you want, and runs on almost any hosting platform.
17-
18-
## Install Botkit
19-
20-
Botkit is a Node.js module, and works with Node and npm.
21-
22-
### **Remix on Glitch**
23-
24-
Want to dive right in? [Remix one of our starter kits on Glitch](https://glitch.com/botkit). You'll start with a fully functioning app that you can edit and run from the browser!
25-
26-
[![Remix on Glitch](https://botkit.ai/docs/glitch.png)](https://glitch.com/botkit)
27-
28-
### **Command Line Interface**
29-
30-
The best way to get started locally with Botkit is by installing our command line tool, and using it to create a new Botkit project. This will install and configure a starter kit for you!
31-
32-
```
33-
npm install -g botkit
34-
botkit new
35-
```
5+
Only security and bug fix updates will be made to this branch!
366

377
### **Start from Scratch**
388

@@ -41,7 +11,7 @@ You can also add Botkit into an existing Node application.
4111
First, add it to your project:
4212

4313
```
44-
npm install --save botkit
14+
npm install --save botkit@0.7.4
4515
```
4616

4717
Then, add Botkit to your application code:
@@ -56,7 +26,7 @@ controller.hears('hello','direct_message', function(bot, message) {
5626
});
5727
```
5828

59-
[Review the documentation](https://botkit.ai/docs/) to learn how to configure Botkit's controller to work with the messaging platform of your choice.
29+
[Review the documentation](https://botkit.ai/docs/v0) to learn how to configure Botkit's controller to work with the messaging platform of your choice.
6030

6131
## Build Your Bot
6232

@@ -82,7 +52,7 @@ controller.hears(['string','pattern .*',new RegExp('.*','i')],'message_received,
8252
});
8353
```
8454

85-
[Read more about hearing things &rsaquo;](https://botkit.ai/docs/core.html#matching-patterns-and-keywords-with-hears)
55+
[Read more about hearing things &rsaquo;](https://botkit.ai/docs/v0/core.html#matching-patterns-and-keywords-with-hears)
8656

8757
### Responding to Events
8858

@@ -96,7 +66,7 @@ controller.on('channel_join', function(bot, message) {
9666
});
9767
```
9868

99-
[See a full list of events and more information about handling them &rsaquo;](https://botkit.ai/docs/core.html#receiving-messages-and-events)
69+
[See a full list of events and more information about handling them &rsaquo;](https://botkit.ai/docs/v0/core.html#receiving-messages-and-events)
10070

10171
### Middleware
10272

@@ -138,25 +108,25 @@ controller.middleware.send.use(function(bot, message, next) {
138108
## Full Documentation
139109

140110
* [Get Started](https://botkit.ai/getstarted.html)
141-
* [Introduction](https://botkit.ai/docs/)
142-
* [Core Features](https://botkit.ai/docs/core.html)
143-
* [Botkit Studio API](https://botkit.ai/docs/readme-studio.html)
111+
* [Introduction](https://botkit.ai/docs/v0)
112+
* [Core Features](https://botkit.ai/docs/v0/core.html)
113+
* [Botkit Studio API](https://botkit.ai/docs/v0/readme-studio.html)
144114
* Platforms
145-
* [Web and Apps](https://botkit.ai/docs/readme-web.html)
146-
* [Slack](https://botkit.ai/docs/readme-slack.html)
147-
* [Cisco Webex](https://botkit.ai/docs/readme-webex.html)
148-
* [Cisco Jabber](https://botkit.ai/docs/readme-ciscojabber.html)
149-
* [Microsoft Teams](https://botkit.ai/docs/readme-teams.html)
150-
* [Facebook Messenger](https://botkit.ai/docs/readme-facebook.html)
151-
* [Twilio SMS](https://botkit.ai/docs/readme-twiliosms.html)
152-
* [Twilio IPM](https://botkit.ai/docs/readme-twilioipm.html)
153-
* [Microsoft Bot Framework](https://botkit.ai/docs/readme-botframework.html)
154-
* [Google Hangouts Chat](https://botkit.ai/docs/readme-google-hangouts.html)
155-
* [Extending Botkit with Plugins and Middleware](https://botkit.ai/docs/middleware.html)
156-
* [Message Pipeline](https://botkit.ai/docs/readme-pipeline.html)
157-
* [List of current plugins](https://botkit.ai/docs/readme-middlewares.html)
158-
* [Storing Information](https://botkit.ai/docs/storage.html)
159-
* [Logging](https://botkit.ai/docs/logging.html)
115+
* [Web and Apps](https://botkit.ai/docs/v0/readme-web.html)
116+
* [Slack](https://botkit.ai/docs/v0/readme-slack.html)
117+
* [Cisco Webex](https://botkit.ai/docs/v0/readme-webex.html)
118+
* [Cisco Jabber](https://botkit.ai/docs/v0/readme-ciscojabber.html)
119+
* [Microsoft Teams](https://botkit.ai/docs/v0/readme-teams.html)
120+
* [Facebook Messenger](https://botkit.ai/docs/v0/readme-facebook.html)
121+
* [Twilio SMS](https://botkit.ai/docs/v0/readme-twiliosms.html)
122+
* [Twilio IPM](https://botkit.ai/docs/v0/readme-twilioipm.html)
123+
* [Microsoft Bot Framework](https://botkit.ai/docs/v0/readme-botframework.html)
124+
* [Google Hangouts Chat](https://botkit.ai/docs/v0/readme-google-hangouts.html)
125+
* [Extending Botkit with Plugins and Middleware](https://botkit.ai/docs/v0/middleware.html)
126+
* [Message Pipeline](https://botkit.ai/docs/v0/readme-pipeline.html)
127+
* [List of current plugins](https://botkit.ai/docs/v0/readme-middlewares.html)
128+
* [Storing Information](https://botkit.ai/docs/v0/storage.html)
129+
* [Logging](https://botkit.ai/docs/v0/logging.html)
160130
* Contributing to Botkit
161131
* [Contributing to Botkit Core](CONTRIBUTING.md)
162132
* [Building platform connectors](https://botkit.ai/docs/howto/build_connector.html)

0 commit comments

Comments
 (0)
This repository has been archived.