UNPKG

dd-botkit/README.md

Version:

1.47 kBMarkdownView Raw

1![Dynastic Development](https://github.com/dynastic/assets/raw/master/images/brand.png)
2
3# BotKit
4###### Examples and documentations will be pushed at a later date.
5
6A minimal framework for rapid creation of Discord bots.
7
8## Getting started
9
10These instructions will explain how to start developing with the BotKit framework.
11
12### Prerequisites
13
14* [A database compatible with TypeORM](https://github.com/typeorm/typeorm/blob/master/docs/supported-platforms.md) *optional*
15* Node 8 or **higher**
16* Yarn *(NPM works as well, but Yarn is preferred)*
17* An internet connection
18
19### Installing
20
21* Run `yarn add dd-botkit`
22
23## Contributing 
24
25Please make a [pull request](/https://github.com/dynastic/place/pulls). Before making a pull request, come and chat with us on [Discord](https://discord.gg/CgC8FTg) in #contributors.
26
27Ensure that all code lints successfully - we have CI that requires this.
28
29### Roadmap
30
31Check our currently open issues for an idea on what to work on!
32
33## Authors
34
35* [Eric Rabil](https://twitter.com/ericrabil) - Lead Developer
36
37Also see the list of [contributors](https://www.github.com/dynastic/botkit/contributors) who participated in this project and helped to make it as great as it is!
38
39## License
40
41BotKit is licensed under a [modified version of the APGL-3.0 license](https://github.com/dynastic/botkit/blob/master/LICENSE). Please see it for details.
42
43## Acknowledgments
44
45Thank you to:
46* Discord.JS for providing a very robust Discord API library

1	`![Dynastic Development](https://github.com/dynastic/assets/raw/master/images/brand.png)`
2
3	`# BotKit`
4	`###### Examples and documentations will be pushed at a later date.`
5
6	`A minimal framework for rapid creation of Discord bots.`
7
8	`## Getting started`
9
10	`These instructions will explain how to start developing with the BotKit framework.`
11
12	`### Prerequisites`
13
14	`* [A database compatible with TypeORM](https://github.com/typeorm/typeorm/blob/master/docs/supported-platforms.md) optional`
15	`* Node 8 or higher`
16	`* Yarn (NPM works as well, but Yarn is preferred)`
17	`* An internet connection`
18
19	`### Installing`
20
21	* Run `yarn add dd-botkit`
22
23	`## Contributing`
24
25	`Please make a [pull request](/https://github.com/dynastic/place/pulls). Before making a pull request, come and chat with us on [Discord](https://discord.gg/CgC8FTg) in #contributors.`
26
27	`Ensure that all code lints successfully - we have CI that requires this.`
28
29	`### Roadmap`
30
31	`Check our currently open issues for an idea on what to work on!`
32
33	`## Authors`
34
35	`* [Eric Rabil](https://twitter.com/ericrabil) - Lead Developer`
36
37	`Also see the list of [contributors](https://www.github.com/dynastic/botkit/contributors) who participated in this project and helped to make it as great as it is!`
38
39	`## License`
40
41	`BotKit is licensed under a [modified version of the APGL-3.0 license](https://github.com/dynastic/botkit/blob/master/LICENSE). Please see it for details.`
42
43	`## Acknowledgments`
44
45	`Thank you to:`
46	`* Discord.JS for providing a very robust Discord API library`