README.md in boilerpipe-ruby-0.2.0 vs README.md in boilerpipe-ruby-0.3.0

- old
+ new

@@ -8,17 +8,23 @@ I saw other gems making use of boilerpipe via the [free api](http://boilerpipe-web.appspot.com) but depending on time of day the api goes down due to exceeding the hosting plan. I also checked out some gems making use of Jruby but I had all kinds of dependency and bug issues. So I made some tweaks on my fork and created a new [jruby-boilerpipe gem](https://rubygems.org/gems/jruby-boilerpipe). This solution works great if you're using Jruby but I wanted a pure ruby solution to use on MRI. Open vim - start coding... -I've only got the ArticleExtractor working but the others should be following quickly as the ArticleExtractor definitley has the most code behind it... +# TLDR +Just use either ArticleExtractor, DefaultExtractor or KeepEverythingExtractor - try out the others when you feel like experimenting... + Presently the follow Extractors are implemented * [x] ArticleExtractor +* [ ] ArticleSentenceExtractor +* [x] CanolaExtractor * [x] DefaultExtractor -* [ ] LargestContentExtractor -* [ ] KeepEverythingExtractor +* [x] KeepEverythingExtractor +* [ ] KeepEverythingWithMinKWordsExtractor +* [x] LargestContentExtractor +* [x] NumWordsRulesExtractor [![CircleCI](https://circleci.com/gh/gregors/boilerpipe-ruby/tree/master.svg?style=shield)](https://circleci.com/gh/gregors/boilerpipe-ruby/tree/master) ## Installation @@ -42,13 +48,21 @@ > require 'boilerpipe' => true > require 'open-uri' => true > content = open('https://blog.carbonfive.com/2017/08/28/always-squash-and-rebase-your-git-commits/').read; true; - > output = Boilerpipe::Extractors::ArticleExtractor.text(content).slice(0..40) + + > Boilerpipe::Extractors::ArticleExtractor.text(content).slice(0..40) => "Always Squash and Rebase your Git Commits" - > output = Boilerpipe::Extractors::DefaultExtractor.text(content).slice(0..40) + + > Boilerpipe::Extractors::DefaultExtractor.text(content).slice(0..40) => "Posted on\nWhat is the squash rebase workf" + + > Boilerpipe::Extractors::LargestContentExtractor.text(content).slice(0, 40) + => "git push origin master\nWhy should you ad" + + > Boilerpipe::Extractors::KeepEverythingExtractor.text(content).slice(0..40) + => "Toggle Navigation\nCarbon Five\nAbout\nWork\n" ## 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.