Skip to content

Commit

Permalink
πŸ“š Update readme for bin/knapsacker
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyf committed Oct 12, 2023
1 parent 2c45754 commit 218d671
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Prior to Hyku Knapsack, organizations would likely clone [Hyku](https://github.c

With Hyku Knapsack, the goal is three-fold:

1. To isolate the upstream Samvera Hyku code from your local modifications. This isolation is via the submodule `./hyrax-webapp` submodule.
1. To isolate the upstream Samvera Hyku code from your local modifications. This isolation is via the `./hyrax-webapp` submodule.
2. To provide a clear and separate space for extending/overriding Hyku functionality.
3. To provide a cleaner pathway for upgrading the underlying Hyku application; for things such as security updates, bug fixes, and upstream enhancements.

Expand All @@ -117,6 +117,8 @@ You can pipe that output into a file and begin working on reviewing and moving f

Once you've moved over the files, you'll want to boot up your Knapsack and then work through your test plan.

The `bin/knapsacker` is general purpose. I have used it to compare one non-Knapsack Hyku instance against Samvera's Hyku. I have also used it to compare a Knapsack's file against it's submodule Hyku instance.

## Installation

If not using a current version, add this line to Hyku's Gemfile:
Expand Down

0 comments on commit 218d671

Please sign in to comment.