update readme #15
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| # OpenSeadragon | ||
| #  | ||
| [](https://travis-ci.com/Islandora-CLAW/openseadragon) | ||
| [](./CONTRIBUTING.md) | ||
| [](./LICENSE) | ||
|
|
@@ -7,19 +8,58 @@ | |
|
|
||
| Drupal 8 FieldFormatter to display an image or generic file using a IIIF Image server and OpenSeadragon. | ||
|
|
||
| ## Requirements | ||
|
|
||
| * [drupal/libraries](https://www.drupal.org/project/libraries) | ||
| * [drupal/token](https://www.drupal.org/project/token) | ||
| * [openseadragon library](https://github.com/openseadragon/openseadragon) | ||
|
|
||
| ## Installation | ||
|
|
||
| As a Drupal module, this module can be installed via composer and enabled via drush, like: | ||
| 1. `composer require islandora/openseadragon:dev-8.x-1.x` | ||
| 2. download the version of openseadragon that you want to install (ie. download a release zip or tar from https://github.com/openseadragon/openseadragon/releases and unarchive it) | ||
| 3. place the version of openseadragon in your drupal install in a location such as `web/sites/all/assets/vendor/openseadragon` | ||
| 4. `drush pm-en openseadragon` | ||
|
|
||
| If you are using the [claw-playbook](https://github.com/Islandora-Devops/claw-playbook), there is an [ansible role](https://github.com/Islandora-Devops/ansible-role-drupal-openseadragon) already built for installing openseadragon. | ||
|
|
||
|
|
||
| ## Configuration | ||
|
|
||
| The module, once enabled will create a configuration page under Configuration > Media > Openseadragon Settings. | ||
| There will be some default settings checked for you. The one setting which you will need to set as a required minimum is the IIIF Image Server Location, such as `http://127.0.0.1:8080/cantaloupe/iiif/2` | ||
| There are a myriad of other configuration settings available there. Additional openseadragon documentation is available [here](https://openseadragon.github.io/#examples-and-features) | ||
| #  | ||
|
|
||
|
|
||
| ## Documentation | ||
|
|
||
| Further documentation for this module is available on the [Islandora 8 documentation site](https://islandora-claw.github.io/CLAW/). | ||
|
|
||
| ## Troubleshooting/Issues | ||
|
|
||
| Having problems or solved a problem? Check out the Islandora google groups for a solution. | ||
|
|
||
| * [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora) * [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev) | ||
|
There was a problem hiding this comment. should be two bullets instead of one line of text. This may be a problem carried over from the template? |
||
|
|
||
| ## Maintainers | ||
|
|
||
| Current maintainers: | ||
|
|
||
| * [Jared Whiklo](https://github.com/whikloj) | ||
|
There was a problem hiding this comment. Should remove the old maintainer. It's all you now, @elizoller 😄 |
||
| * [Eli Zoller](https://github.com/elizoller) | ||
|
|
||
|
|
||
| ## Development | ||
|
|
||
| If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora-CLAW/CLAW/wiki). We love to hear from you! | ||
|
|
||
| If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information. | ||
|
|
||
| We recommend using the [claw-playbook](https://github.com/Islandora-Devops/claw-playbook) to get started. If you want to pull down the submodules for development, don't forget to run `git submodule update --init --recursive` after cloning. | ||
|
|
||
| ## License | ||
|
|
||
| [GPLv2](https://github.com/Islandora-CLAW/openseadragon/blob/8.x-1.x/LICENSE) | ||
|
There was a problem hiding this comment. This link works, but I think it can be simplified to |
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Image should go before the repo name so they end up on the same lie:
#  Repository Name