Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Satoru committed Dec 7, 2023
1 parent 48ed1cb commit f035a95
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@
[![npm version](https://badge.fury.io/js/mirador-rotation.svg)](https://badge.fury.io/js/mirador-rotation) -->


`mirador-rotation` is a [Mirador 3](https://github.com/projectmirador/mirador) plugin that adds layer slideshow.
`mirador-rotation` is a [Mirador 3](https://github.com/projectmirador/mirador) plugin that enables the rotation of images at any angle.

<!-- ![Mirador layer slideshow example](assets/demo.gif) -->

<img src="assets/demo.gif" width="100%" title="Mirador layer slideshow example">
<img src="assets/demo.gif" width="100%" title="Mirador rotation example">

**Demo on https://nakamura196.github.io/mirador-rotation-plugin/**
## 🌐 Website

## Configuration
[Visit the demo page](https://nakamura196.github.io/mirador-rotation-plugin/) to try it out.

## 📖 Configuration
Several configuration options are available on windows that use mirador-rotation.


Expand All @@ -31,9 +33,13 @@ const config = {
}]
};
```
## Installing `mirador-rotation`
## 📖 Installing `mirador-rotation`

`mirador-rotation` requires an instance of Mirador 3. See the [Mirador wiki](https://github.com/ProjectMirador/mirador/wiki) for examples of embedding Mirador within an application. See the [live demo's index.js](https://github.com/nakamura196/mirador-rotation-plugin/blob/main/demo/src/index.js) for an example of importing the `mirador-rotation` plugin and configuring the adapter.

## Contribute
## 📣 Contribute
Mirador's development, design, and maintenance is driven by community needs and ongoing feedback and discussion. Join us at our regularly scheduled community calls, on [IIIF slack #mirador](http://bit.ly/iiif-slack), or the [mirador-tech](https://groups.google.com/forum/#!forum/mirador-tech) and [iiif-discuss](https://groups.google.com/forum/#!forum/iiif-discuss) mailing lists. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.

## 🏅 Sponsors

[Become a sponsor](https://opencollective.com/nakamura196#sponsor)
Binary file modified assets/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mirador-rotation",
"version": "0.11.0",
"version": "0.1.0",
"description": "mirador-rotation React component",
"main": "lib/index.js",
"module": "es/index.js",
Expand Down

0 comments on commit f035a95

Please sign in to comment.