Skip to content

collectionspace/collectionspace-refcache

Repository files navigation

CollectionSpace RefCache

A caching system for CollectionSpace refnames.

Installation

Add this line to your application's Gemfile (replace $VERSION with an available tag):

gem 'collectionspace-refcache', tag: $VERSION, git: 'https://github.com/collectionspace/collectionspace-refcache.git'

And then execute:

bundle install

Usage

Follow the examples!

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. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/collectionspace/collectionspace-refcache.

License

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