From d27fd7e3a39a0cbc07ba88333c430b63ca61e830 Mon Sep 17 00:00:00 2001 From: Jack Reed Date: Tue, 14 Jun 2016 16:32:01 +0100 Subject: [PATCH] add a bare bones contributing guide and how to run the specs --- CONTRIBUTING.md | 10 ++++++++++ README.md | 6 ++++++ 2 files changed, 16 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cead7fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing to Leaflet-IIIF + +Thanks for thinking about contributing to Leaflet-IIIF! + +## Contributing Code +When contributing code, please follow the code and whitespace styles already established. Also test your new functionality by writing a test and running the test suite. + +``` +npm test +``` diff --git a/README.md b/README.md index e1a001e..a313b40 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,12 @@ Run the server $ npm start ``` +Run the test suite + +``` +$ npm test +``` + Access the examples at http://127.0.0.1:8080/examples/example.html ### Leaflet-IIIF Examples