Skip to content

Commit

Permalink
Add directions for node-based bundler
Browse files Browse the repository at this point in the history
  • Loading branch information
jcoyne authored Dec 13, 2024
1 parent 4b18fa8 commit d167d9a
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,18 @@ Or install it yourself as:

## Usage

Run the gallery generator:
Run the gallery generator for Sprockets:

$ rails g blacklight_gallery:install

Or for node based bundlers add `blacklight-gallery` as a dependency and add this to your entrypoint:
```js
import 'blacklight-gallery/vendor/assets/javascripts/imagesloaded.min.js'
import 'blacklight-gallery/vendor/assets/javascripts/masonry.min.js'
import 'blacklight-gallery/app/assets/javascripts/blacklight_gallery/slideshow'
import 'blacklight-gallery/app/assets/javascripts/blacklight_gallery/masonry'
```

## Available Views
If you would like to add or remove any particular view either add or remove the following configurations from your Blacklight controller.

Expand Down Expand Up @@ -56,4 +64,4 @@ If you would like to add or remove any particular view either add or remove the
1. Commit the changes e.g. `git commit -am "Bump version to X.X.X"`
1. Push release to rubygems `bundle exec rake release`
1. Push release to NPM `npm publish`
1. Create a release on github with the tag that was just created: https://github.com/projectblacklight/blacklight-gallery/releases/new
1. Create a release on github with the tag that was just created: https://github.com/projectblacklight/blacklight-gallery/releases/new

0 comments on commit d167d9a

Please sign in to comment.