indieweb-post_types-identifier-read

Indieweb::PostTypes::Identifier::Read

Indieweb::PostTypes::Identifier::Read is a Ruby gem to extend Indieweb::PostTypes discovery to support the read post type.

Installation

Add this line to your application's Gemfile:

gem 'indieweb-post_types-identifier-read'

And then execute:

$ bundle

Or install it yourself as:

$ gem install indieweb-post_types-identifier-read

Usage

Once the gem is installed you need to configure Indieweb::PostTypes to use it. The following code would configure Indieweb::PostTypes to use the read identifier before the default article identifier. You could also choose to insert the read identifier before a different identifier if you so wish.

Indieweb::PostTypes.configure do |config|
  config.insert_identifier(klass: Indieweb::PostTypes::Identifier::Read,
                           before: Indieweb::PostTypes::Identifier::Article)
end

Then just use Indieweb::PostTypes as normal...

post_type = Indieweb::PostTypes.type_from(data)

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.

Contributing

Bug reports can be added at https://code.deeden.co.uk/indieweb-post_types-identifier-read/issues, while patches are welcome at https://code.deeden.co.uk/indieweb-post_types-identifier-read/patches.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.