README.md in ebooks-0.0.1 vs README.md in ebooks-0.1.0

- old
+ new

@@ -1,9 +1,14 @@ # Ebooks -Generate your own horse_ebooks by @busterbenson and compiled as a gem by @parkr +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' @@ -14,12 +19,53 @@ 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 -TODO: Write usage instructions here +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`)