diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..40b878d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules/ \ No newline at end of file diff --git a/Gruntfile.js b/Gruntfile.js new file mode 100644 index 0000000..004c705 --- /dev/null +++ b/Gruntfile.js @@ -0,0 +1,14 @@ +module.exports = function(grunt) { + // Do grunt-related things in here + grunt.initConfig({ + connect: { + uses_defaults: {} + }, + watch: { + + } + }); + + grunt.loadNpmTasks('grunt-contrib-connect'); + grunt.loadNpmTasks('grunt-contrib-watch'); +}; diff --git a/README.md b/README.md index 8d3d172..29209ca 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ A Leaflet plugin for viewing IIIF images. [See the demo](http://mejackreed.githu Requires [Leaflet.js](http://leafletjs.com/) and [jQuery](http://jquery.com/) -#### Install with Bower +### Install with Bower ``` $ bower install leaflet-iiif ``` -#### Quick and easy to get going. +### Quick and easy to get going. ``` var map = L.map('map', { @@ -24,7 +24,23 @@ L.tileLayer.iiif('http://example.com/iiifimage.jp2/info.json').addTo(map); Thanks to [klokantech/iiifviewer](https://github.com/klokantech/iiifviewer) and [turban/Leaflet.Zoomify](https://github.com/turban/Leaflet.Zoomify) who have similar plugins which were used in development of Leaflet-IIIF. -#### Examples of use +### Development + +Clone the repository + +``` +$ git clone https://github.com/mejackreed/Leaflet-IIIF.git +``` + +Run the server + +``` +$ grunt connect watch +``` + +Access the examples at http://127.0.0.1/examples/example.html + +### Leaflet-IIIF in the wild Princeton Libraries used Leaflet-IIIF for its ["Plan of Versailles"](Plan of Versailles) map. This implementation uses GeoJSON annotation to annotate the map being served out by a IIIF server. diff --git a/package.json b/package.json new file mode 100644 index 0000000..ecf4ed9 --- /dev/null +++ b/package.json @@ -0,0 +1,33 @@ +{ + "name": "leaflet-iiif", + "version": "0.0.5", + "description": "A Leaflet plugin for viewing IIIF sources", + "main": "leaflet-iiif.js", + "directories": { + "example": "examples" + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "https://github.com/mejackreed/Leaflet-IIIF.git" + }, + "keywords": [ + "Leaflet", + "IIIF", + "map", + "zoom" + ], + "author": "Jack Reed", + "license": "MIT", + "bugs": { + "url": "https://github.com/mejackreed/Leaflet-IIIF/issues" + }, + "homepage": "https://github.com/mejackreed/Leaflet-IIIF", + "devDependencies": { + "grunt": "^0.4.5", + "grunt-contrib-connect": "^0.10.1", + "grunt-contrib-watch": "^0.6.1" + } +}