README: add coverage matrix

README.md

@@ -1,6 +1,15 @@
 # BURP: A Basic and Unassuming RML Processor
 
-## Building and using the code
+BURP (Basic and Unassuming RML Processor) is a reference implementation for the new [RML specification](http://w3id.org/rml/portal) which has been written from scratch to have no influence from prior implementations of RML.
+BURP was created to serve as a reference RML implementation for the Knowledge Graph Construction community and to verify the RML specifications their feasibility and coverage of their test cases.
+
+## Coverage matrix
+
+| [RML-Core](http://w3id.org/rml/core/spec) | [RML-IO](http://w3id.org/rml/io/spec) | [RML-CC](http://w3id.org/rml/cc/spec) | [RML-FNML](http://w3id.org/rml/fnml/spec) | [RML-Star](http://w3id.org/rml/star/spec) |
+| ----------------------------------------- | ------------------------------------- | ------------------------------------- | ----------------------------------------- | ----------------------------------------- |
+| ✔️ 100% coverage                          | 🚧 Source yes, Target WIP              | ✔️ 100% coverage                      | ✔️ 100% coverage                          | 🚧 WIP                                     |
+
+## Building BURP
 
 To build the project and copy its dependencies, execute
 
@@ -11,6 +20,8 @@ $ mvn dependency:copy-dependencies
 
 You can add `-DskipTests` after `mvn package` to skip the unit tests. The tests do rely on Docker for testing mappings on top of MySQL and PostgreSQL.
 
+## Using BURP
+
 The run the R2RML processor, execute the following command:
 
 ```bash
@@ -28,4 +39,25 @@ Usage: burp [-h] [-b=<baseIRI>] -m=<mappingFile> [-o=<outputFile>]
                             The output file
 ```
 
-If no outputFile is provided and the RML mapping does not rely on RML-IO for targets, then the output is written to the standard output.
+If no outputFile is provided and the RML mapping does not rely on RML-IO for targets, then the output is written to the standard output.
+
+## Citation
+
+If you use BURP, please cite our paper:
+
+```
+@inproceedings{vanassche2024BURP,
+  title={{BURPing Through RML Test Cases}},
+  author={Van Assche, Dylan and Debruyne, Christophe},
+  year={2024},
+  month={may},
+  version={1.0.0},
+  doi={TODO},
+  url={https://github.com/kg-construct/BURP},
+  license={{MIT}},
+}
+```
+
+## License
+
+BURP is released under the [MIT license](./LICENSE).