Skip to content

Commit ef12f75

Browse files
committed
Update documentation
1 parent 600de06 commit ef12f75

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ A simple way to expose static assets as a read-only LDP server.
55
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg?style=flat-square)](https://php.net/)
66
[![Build Status](https://travis-ci.org/trellis-ldp/static-ldp.svg?branch=master)](https://travis-ci.org/trellis-ldp/static-ldp)
77

8+
## Requirements
9+
10+
* PHP 5.6+
11+
* [Composer](https://getcomposer.org/)
12+
13+
## Basics
14+
815
Clone this repository and setup your Apache to use it as
916
document root. Then configure the `sourceDirectory` to point
1017
to the root directory of your static resources.
@@ -13,10 +20,12 @@ Individual files are served as `ldp:NonRDFSource` resources,
1320
and directories are served as `ldp:BasicContainer` resources.
1421
If a static file is a RDF file, then it is served as an `ldp:RDFSource`.
1522

16-
## Requirements
17-
18-
* PHP 5.6+
19-
* [Composer](https://getcomposer.org/)
23+
It is also possible to describe `ldp:NonRDFSource` resources via the `Link: <IRI>; rel="describedby"`
24+
header. For example, if a JPEG file is named `rosid_rosaceae.jpg`, then by adding an RDF file with
25+
the name `rosid_rosaceae.jpg.ttl` (or any valid RDF format such as `rosid_rosaceae.jpg.jsonld`), then
26+
requests to `rosid_rosaceae.jpg` will include a link header pointing to the `ldp:RDFSource`.
27+
Similarly, the `ldp:RDFSource` will contain a link header (`rel="describes"`) pointing to the
28+
`ldp:NonRDFSource`.
2029

2130
## Installation
2231

0 commit comments

Comments
 (0)