voxable-labs/hg

# Hg

<p align=center>
  <a title="Gem Version" href="https://rubygems.org/gems/hg">
    <img src="https://img.shields.io/gem/v/hg.svg" />
  </a>
  <a title="Linux Build Status" href="https://travis-ci.org/voxable-labs/expando">
    <img src="https://img.shields.io/travis/voxable-labs/expando/master.svg?label=Linux%20build" />
  </a>
   <a title="Code Climate" href="https://codeclimate.com/github/voxable-labs/hg">
    <img src="https://img.shields.io/codeclimate/github/voxable-labs/hg.svg" />
  </a>
  <a title="Test Coverage" href="https://codeclimate.com/github/voxable-labs/hg/coverage">
    <img src="https://img.shields.io/codeclimate/coverage/github/voxable-labs/hg.svg" />
  </a>
  <a title="Dependency Status" href="https://gemnasium.com/voxable-labs/hg">
    <img src="https://img.shields.io/gemnasium/voxable-labs/hg.svg" />
  </a>
  <a title="Security" href="https://hakiri.io/github/voxable-labs/hg/master">
    <img src="https://hakiri.io/github/voxable-labs/hg/master.svg" />
  </a>
</p>

**NB: This gem is still under heavy development, and is likely going to change wildly between releases. You probably shouldn't use it quite yet. [Follow Voxable](https://www.voxable.io/blog) and we'll let you know when it's ready!**

Hg is a conversational interface framework for Ruby on Rails. It dramatically simplifies the process of building voice interfaces and chatbots for a variety of messaging platforms.

## Getting Started

### Installation
Add this line to your application's Gemfile:

```ruby
gem 'hg'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install hg
    
### Configuration
Create an initializer file within your Rails app at `config/initializers/bot.rb`
    

## Usage
TODO: Write usage instructions here

## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Documentation
The source code is documented in the literate style. You can view the docs [here](http://www.rubydoc.info/github/voxable-labs/hg/master).

## Contributing
Bug reports and pull requests are welcome [on GitHub](http://github.com/voxable-labs/hg).

## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).