diff --git a/README.md b/README.md index 3275ef8..2c92350 100644 --- a/README.md +++ b/README.md @@ -8,26 +8,26 @@ composer require yale-web-technologies/iiif-manifest-generator Requires PHP >=8.1. ### Usage ### -Resources are mapped to class types. Methods are available to add objects embedded within a resource. Passing true to the constructor of a resource will make it a top level resource within the JSON. +Resources are mapped to class types. Methods are available to add objects embedded within a resource. Passing true to the constructor of a resource will make it a top level resource within the JSON. ```PHP setID("http://example.org/iiif/book1/manifest"); $manifest->addLabel("Book 1"); - + $thumbnail = new Thumbnail(); $manifest->addThumbnail($thumbnail); $thumbnail->setID("http://example.org/images/book1-page1/full/80,100/0/default.jpg"); - + $service_thumbnail = new Service(); $thumbnail->setService($service_thumbnail); $service_thumbnail->setContext("http://iiif.io/api/image/2/context.json"); $service_thumbnail->setID("http://example.org/images/book1-page1"); $service_thumbnail->setProfile("http://iiif.io/api/image/2/level1.json"); - + $sequence = new Sequence(); $manifest->addSequence($sequence); $sequence->setID("http://example.org/iiif/book1/sequence/normal"); @@ -40,7 +40,16 @@ Resources are mapped to class types. Methods are available to add objects embed $canvas->setWidth(500); $canvas->setHeight(500); ``` -See the docs folder for implementation specifications. + +### Generating Documentation +Documentation is generated through [`phpdocumentor`](https://docs.phpdoc.org/). To create the documentation run the following: + +```sh +composer install +vendor/bin/phpdoc +``` + +To modify how the documentation is generated, a custom `phpdoc.xml` file can be provided. See the [`phpdocumentor` configuration docs](https://docs.phpdoc.org/guide/getting-started/configuration.html#configuration) for more details. ### TODO ### - Implement Image API