Skip to content

Commit

Permalink
Updated README with Hyrax compatability information and set newspaper… (
Browse files Browse the repository at this point in the history
#215)

* Updated README with Hyrax compatability information and set newspaper_works.gemspec to allow Hyrax '>= 2.5', '< 2.8'
  • Loading branch information
brianmcbride authored Jul 29, 2020
1 parent 0ee8eb7 commit 35a698e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv
<!-- /TOC -->

# Overview
NewspaperWorks is a gem (Rails "engine") for [Hyrax](https://hyrax.samvera.org/) -based digital repository applications to support ingest, management, and display of digitzed newspaper content.
NewspaperWorks is a gem (Rails "engine") for [Hyrax](https://hyrax.samvera.org/) -based digital repository applications to support ingest, management, and display of digitized newspaper content.

NewspaperWorks is not a stand-alone application. It is designed to be integrated into a new or existing Hyrax (2.6) application, providing content models, ingest workflows, and feature-rich UX for newspaper repository use-cases.
NewspaperWorks is not a stand-alone application. It is designed to be integrated into a new or existing Hyrax (v2.5-v2.7) application, providing content models, ingest workflows, and feature-rich UX for newspaper repository use-cases.

NewspaperWorks supports:
* models for Title, Issue, Page, and Article
Expand All @@ -52,10 +52,10 @@ A set of helpful documents to help you learn more and deploy NewspaperWorks can

## Requirements

* [Ruby](https://rubyonrails.org/) >=2.4
* [Rails](https://rubyonrails.org/) ~>5.1
* [Ruby](https://rubyonrails.org/) >=2.4
* [Rails](https://rubyonrails.org/) ~>5.1.7
* [Bundler](http://bundler.io/)
* [Hyrax](https://github.com/samvera/hyrax) ~>2.6
* [Hyrax](https://github.com/samvera/hyrax) v2.5-v2.7
- ..._and various [Samvera dependencies](https://github.com/samvera/hyrax#getting-started) that entails_.
* A Hyrax-based Rails application

Expand All @@ -69,6 +69,7 @@ A set of helpful documents to help you learn more and deploy NewspaperWorks can
* [ImageMagick](https://github.com/ImageMagick/ImageMagick6)
- _ImageMagick policy XML may need to be more permissive in both resources and source media types allowed. See template [policy.xml](config/vendor/imagemagick-6-policy.xml)._
* [libcurl3](https://packages.ubuntu.com/search?keywords=libcurl3)
* [libgbm1](https://packages.debian.org/sid/libgbm1)

See the [wiki](https://github.com/samvera-labs/newspaper_works/wiki/Installing,-Developing,-and-Testing) for more details on how to install and configure dependencies.

Expand Down
2 changes: 1 addition & 1 deletion newspaper_works.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ SUMMARY
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
spec.add_dependency 'blacklight_iiif_search', '~> 1.0'
spec.add_dependency 'blacklight_advanced_search', '6.4.1'
spec.add_dependency 'hyrax', '~> 2.6.0'
spec.add_dependency 'hyrax', '>= 2.5', '< 2.8'
spec.add_dependency 'nokogiri'
spec.add_dependency 'rails', '~> 5.1.7'
spec.add_dependency 'rdf-vocab', '< 3.1.5'
Expand Down

0 comments on commit 35a698e

Please sign in to comment.