README.md in lita-wit-0.1.0 vs README.md in lita-wit-0.1.1
- old
+ new
@@ -1,31 +1,55 @@
# lita-wit
[](https://travis-ci.org/dbastin/lita-wit)
[](https://coveralls.io/r/dbastin/lita-wit)
-Receive structured intentions from unstructured sentences using a [Lita](https://www.lita.io) bot and [Wit](https://www.wit.ai).
+This is a [Lita](https://www.lita.io) handler to converse with [Wit.ai](https://www.wit.ai)
+Using Lita and Wit.ai, you can easily create text or voice based bots that humans can chat with on their preferred messaging platform.
+
+Something like this Slack snippet...
+
+
+
+This above snippet is a conversation with a publically accessible pre-configured Wit.ai chatbot - https://wit.ai/dbastin/Lita.
+As you can guess, Wit.ai not only enables your robot to understand humans, it also helps you discover their unforeseen needs.
+
## Installation
Add lita-wit to your Lita instance's Gemfile:
``` ruby
gem "lita-wit"
```
## Configuration
-You'll need to add the wit.ai API Bearer key.
+You'll need to add the Wit.ai API server access token.
``` ruby
-config.wit_token = token-here
+Lita.configure do |config|
+ # config... config... config...
+
+ # https://wit.ai/dbastin/Lita... Fork it!
+ config.handlers.wit.server_access_token = '72XXMP6VAKG2SAPLTXVQS6H5PBLVQIJW'
+end
```
## Usage
-Rock!
+Just send a message mentioning your robot by it's name or alias, either directly as a command or anywhere else in the message.
-## Thanks Go To
+```
+> Lita, is it raining in Istanbul?
+#=> Sorry, I don't know what the weather is like in Istanbul. I'm just a simple chatbot who loves a chat.
+
+> Ok. Tell me if it is snowing lita.
+#=> Where exactly?
+```
+
+Your robot's name will be stripped from the message we send to Wit.ai
+
+## Thanks
[Tom Beynon](https://github.com/tombeynon) - Great handler for Cleverbot [lita-ai](https://github.com/tombeynon/lita-ai)