From 9e40318814faf9daf24cb9f86cdb5d2ca829c961 Mon Sep 17 00:00:00 2001 From: Braiden Vasco Date: Sun, 13 Sep 2015 20:29:40 +0000 Subject: [PATCH] Add instructions --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 7d74260..a588c19 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,39 @@ which should be fixed in first release: (see [source code of **libtoxcore**](https://github.com/irungentoo/toxcore/blob/2ab3b14731061cc04d3ccc50a35093c11d018298/toxcore/tox.h#L252-L255)) * Adapter has incomplete API for Lita. Only basic methods are implemented + + +Usage +----- + +At first, see the documentation for Lita: http://docs.lita.io/ + +### Installation + +**libtoxcore** should be compiled manually at your computer or server. +Follow the instructions at +[that file](https://github.com/irungentoo/toxcore/blob/2ab3b14731061cc04d3ccc50a35093c11d018298/INSTALL.md) + +When **libtoxcore** is installed, add **lita-tox** +to your Lita instance's Gemfile: + +```ruby +gem 'lita-tox', '~> 0.0.0' +``` + +### Configuration + +No configuration is needed. You only have to specify adapter as `:tox` + +#### Example + +This is an example `lita_config.rb` file: + +```ruby +Lita.configure do |config| + config.robot.name = 'Lita' + config.robot.mention_name = 'lita' + + config.robot.adapter = :tox +end +```