Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mary-crkn authored Nov 12, 2024
1 parent 8156560 commit 4b54876
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# IIIF Presentation API

CRKN module

## Table of Contents

1. [Description](#description)
1. [Usage - Configuration options and additional functionality](#usage)
1. [Limitations - OS compatibility, etc.](#limitations)
1. [Development - Guide for contributing to the module](#development)

## Description

This API allows users to upload a IIIF manifest.json file to Swift containers and retrieve a manifest.json file by searching for a manifest ID.

## Usage

This module is used as the backend for the Digirati editor: https://github.com/crkn-rcdr/crkn-digirati-editor.

## Limitations

The uploaded manifest.json file must comply with the IIIF Presentation API requirements. The API includes a manifest.json validator from https://presentation-validator.iiif.io/.

## Development

The functionality of upload is udes only by CRKN.

0 comments on commit 4b54876

Please sign in to comment.