Skip to content

Commit

Permalink
Merge branch 'master' into devel
Browse files Browse the repository at this point in the history
  • Loading branch information
mzilinec committed Jun 10, 2019
2 parents 683f369 + 8cea9f5 commit ffae192
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@

# Botshot chatbot framework
# Botshot Chatbot Framework

![CodeFactor](https://www.codefactor.io/repository/github/botshot/botshot/badge?style=flat-square)
![PyPI](https://img.shields.io/pypi/v/botshot.svg)
![PyPI - Status](https://img.shields.io/pypi/status/botshot.svg)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/botshot.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/botshot/botshot.svg)
![Read the Docs](https://img.shields.io/readthedocs/botshot.svg)
![GitHub](https://img.shields.io/github/license/botshot/botshot.svg)


<!--![GitHub last commit](https://img.shields.io/github/last-commit/botshot/botshot.svg)-->
<!-- ![PyPI - Django Version](https://img.shields.io/pypi/djversions/botshot.svg) -->
<p>
<img src="https://raw.githubusercontent.com/botshot/botshot/devel/docs/images/botshot.png" height="100"/>
Expand All @@ -20,38 +22,39 @@ With Botshot, you can build complex chatbots that remember past conversations.

Botshot can:
- __Receive messages__ from __Messenger__, __Telegram__ or __Amazon Alexa__ (more platforms coming soon)
- __Understand__ these messages using your favorite **NLU** service
- __Understand__ and parse messages using a **NLU** service
- e.g. "Show me the best concert" -> *intent:* recommend, *query:* concert
- __Keep track of the history__ of the conversation *(context)*
- __Move between different states__ of the conversation based on the context
- __Manage the dialogue__ and move between the conversation's states
- __Keep track of the context__ and history of the conversation
- __Send messages__ and media back to the user
- __Send proactive messages__ and notifications
- __Connect__ to 3rd party APIs and analytics
<!-- - It's __language independent__ -->
<!-- - It has a __web chat GUI__ for easy testing -->

## Getting started

Just install the package and run our `bots` init script.
Just install the package and run the `bots` script. You will also need the Redis database.
```bash
sudo apt install redis-server
pip3 install botshot
bots init my_bot && cd my_bot
bots start
```

That's it! Now open http://localhost:8000/chat and chat with your bot.
That's it! Now open http://127.0.0.1:8000/chat and chat with your bot.

You may also want to add some actual content, so check the docs ;-)

## Docs

It's quite easy to get started!

Find out how to make your own bot in the **[Docs](https://botshot.readthedocs.io)**.
Find out how to make your own chatbot in the **[Docs](https://botshot.readthedocs.io)**.

Questions? [Join us on Slack!](https://botshot-slackin.herokuapp.com/)

## Authors
- David P艡铆hoda - [prihoda](https://github.com/prihoda)
- Mat煤拧 沤ilinec - [mzilinec](https://github.com/mzilinec)
- David P艡铆hoda - [prihoda](https://github.com/prihoda)
- Jakub Drd谩k - [drdakjak](https://github.com/drdakjak)


Expand Down

0 comments on commit ffae192

Please sign in to comment.