Contents

# Ebooks

Generate your own horse_ebooks by [@busterbenson][] ([original gist][], [blog post][]) and compiled as a gem by [@parkr][]

[@busterbenson]: http://wayoftheduck.com/
[original gist]: https://gist.github.com/busterbenson/6695350
[blog post]: http://wayoftheduck.com/diy-horse-ebooks
[@parkr]: https://parkermoo.re

## Installation

Add this line to your application's Gemfile:

    gem 'ebooks'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ebooks

## Configuration

The `ebooks` executable and `Ebooks.read_config_file` will load in a yaml file
(`~/.ebooks` by default) if you want to set your own defaults.

Here are the gem's defaults:

```yaml
:tweets_csv_path: 'tweets.csv'
:corpus_path:     'markov_dict.txt'
:dictionary_name: 'dictionary'
:twitter:
  :consumer_key: ''
  :consumer_secret: ''
  :oauth_token: ''
  :oauth_token_secret: ''
```

## Usage

As an API:

```ruby
config = Ebooks.configuration(my_overrides)

# Generate a sentence and return it
Ebooks.generate(config)

# Generate sentence and tweet it
Ebooks.tweet(config)

# Just tweet a sentence
Ebooks::Twitter.new(config[:twitter]).tweet(my_sentence)
```

As an executable:

```bash
# To generate a new horse_ebooks sentence:
ebooks generate

# To generate a new sentence and tweet it:
ebooks tweet
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ebooks-0.2.1	README.md
ebooks-0.2.0	README.md
ebooks-0.1.0	README.md