Skip to content
This repository has been archived by the owner on Mar 6, 2020. It is now read-only.

Latest commit

 

History

History
40 lines (25 loc) · 1.69 KB

README.md

File metadata and controls

40 lines (25 loc) · 1.69 KB
Raw

ReadabilityAgent

The Huginn Readability Agent extracts the primary readable content of a website using the readability gem.

Installation

Add this string to your Huginn's .env ADDITIONAL_GEMS configuration:

huginn_readability_agent(github: kreuzwerker/DKT.huginn_readability_agent)
# when only using this agent gem it should look like hits:
ADDITIONAL_GEMS=huginn_readability_agent(github: kreuzwerker/DKT.huginn_readability_agent)

And then execute:

$ bundle

Development

Running rake will clone and set up Huginn in spec/huginn to run the specs of the Gem in Huginn as if they would be build-in Agents. The desired Huginn repository and branch can be modified in the Rakefile:

HuginnAgent.load_tasks(branch: 'master', remote: 'https://github.com/cantino/huginn.git')

Make sure to delete the spec/huginn directory and re-run rake after changing the remote to update the Huginn source code.

After the setup is done rake spec will only run the tests, without cloning the Huginn source again.

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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/kreuzwerker/DKT.huginn_readability_agent/fork )
  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 a new Pull Request