CottageLabs / willow_sword

Swordv2 engine for Willow

WillowSword

A Ruby on Rails engine for the Sword V2 server. The Sword server is currently integrated with Hyrax V2.

Installation

Add this line to your application's Gemfile:

gem 'willow_sword', git: 'https://github.com/CottageLabs/willow_sword.git'

And then execute:

$ bundle

Or install it yourself as:

$ gem install willow_sword

Mount the engine. Add this line to config/routes.rb

mount WillowSword::Engine => '/sword'

Configuration

The plugin has a few configuration options. To view the current default options and override these, see configuration options

Enable authorization

If you would like to authorize all Sword requests using an Api-key header, see Enabling authorization

Usage

To use the plugin see usage.

Contributing

Contribution directions go here.

License

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