diff --git a/js/ui/botui/README.md b/js/ui/botui/README.md new file mode 100644 index 0000000..c3141f8 --- /dev/null +++ b/js/ui/botui/README.md @@ -0,0 +1,60 @@ +# BotUI + +[![Join the chat at https://gitter.im/BotUIChat/botui](https://badges.gitter.im/BotUIChat/botui.svg)](https://gitter.im/BotUIChat/botui?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![npm](https://img.shields.io/npm/v/botui.svg?style=flat-square)](https://www.npmjs.com/package/botui) [![npm](https://img.shields.io/npm/dm/botui.svg?style=flat-square)](https://www.npmjs.com/package/botui) [![newsletter](newsletter.png)](https://tinyletter.com/moinhq) + +> A JavaScript framework to create conversational UIs. + + +[Main Site](https://botui.org) - [Read Docs](https://docs.botui.org) - [Examples](https://github.com/moinism/botui-examples) + +## Showcase 🎇✨ + +We are listing all the cool projects that people are building with BotUI, [here](https://github.com/botui/botui/blob/master/Showcase.md). See others' and add yours! + +### Quick look + +![preview](preview.png) + +```html +
+ +
+``` + +```javascript +var botui = new BotUI('botui-app'); // give it the id of container + +botui.message.bot({ // show first message + delay: 200, + content: 'hello' +}).then(function () { + return botui.message.bot({ // second one + delay: 1000, // wait 1 sec. + content: 'how are you?' + }); +}).then(function () { + return botui.action.button({ // let user do something + delay: 1000, + action: [ + { + text: 'Good', + value: 'good' + }, + { + text: 'Really Good', + value: 'really_good' + } + ] + }); +}).then(function (res) { + return botui.message.bot({ + delay: 1000, + content: 'You are feeling ' + res.text + '!' + }); +}); +``` + + +### License + +[MIT License](https://github.com/moinism/botui/blob/master/LICENSE) - Copyrights (c) 2017 - Moin Uddin