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

Commit 95d0a73

Browse files
committed
add yeoman genetor gif
1 parent e794d41 commit 95d0a73

File tree

3 files changed

+31
-3
lines changed

3 files changed

+31
-3
lines changed

packages/generator-botkit/readme.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
11
# generator-botkit
2-
## a yeoman template for generating botkit applications
2+
**A [Yeoman](https://yeoman.io) template for generating [Botkit](https://npmjs.org/package/botkit) applications**
3+
4+
## Get Started
5+
6+
Install Yeoman and this template:
7+
8+
```bash
9+
npm install -g yo generator-botkit
10+
```
11+
12+
Create a new folder for your project:
13+
14+
```bash
15+
mkdir mybot
16+
cd mybot
17+
```
18+
19+
From inside your project folder, generate the project:
20+
21+
```bash
22+
yo botkit
23+
```
24+
25+
The generator will walk you through the process of configuring and installing your Botkit application. For each platform, a different set of API credentials and options will be collected. [Platform specific provisioning guides can be found in the Botkit docs site](https://botkit.ai/docs/provisioning).
26+
27+
Once the generator has completed its work, you will be left with a fully operational bot ready to be connected to the messaging platform. To start the application, run `npm start`
28+
29+
The entire process is shown below:
30+
31+
![Botkit Yeoman generator in action](yeoman-generator.gif)
332

433
## Community & Support
534

1.08 MB
Loading

todo.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
* PUBLISH TO NPM
44
* move/remove/ignore testbot
55
* eslint version in packages
6-
76

87
# core
98

@@ -39,7 +38,6 @@
3938

4039
# starter kits / yeoman
4140

42-
* hangouts creds get escaped
4341
* move over more useful skills
4442

4543
* keep? Go? mark as deprecated? point at yeoman? autogenerate with yeoman??
@@ -78,6 +76,7 @@
7876
~* change /new to /v4~
7977
~* create official new 0. branch for future maintenance~
8078
~* catch dialog results!~
79+
~* hangouts creds get escaped~
8180

8281

8382
# POST LAUNCH

0 commit comments

Comments
 (0)