diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..d9b8af3 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,28 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite the article." +authors: + - family-names: "Klima" + given-names: "Karel" +title: "LDkit" +version: 2.4.0 +doi: 10.5281/zenodo.15485481 +date-released: 2025-05-21 +url: "https://ldkit.io/" +preferred-citation: + type: conference-paper + authors: + - family-names: "Klíma" + given-names: "Karel" + - family-names: "Taelman" + given-names: "Ruben" + - family-names: "Nečaský" + given-names: "Martin" + doi: "10.1007/978-3-031-47243-5_11" + collection-title: "International Semantic Web Conference" + publisher: + name: "Springer Nature Switzerland" + month: 10 + start: 194 # First page number + end: 210 # Last page number + title: "LDkit: Linked Data Object Graph Mapping Toolkit for Web Applications" + year: 2023 diff --git a/README.md b/README.md index 05772ac..0b12e4c 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,12 @@ Persons.delete("http://dbpedia.org/resource/Alan_Turing"); More complex examples can be found in [documentation](https://ldkit.io/docs). +## Minimum software requirements + +- TypeScript v5.5 or newer +- Node.js v20.19.3 or newer +- Deno v2.1 or newer + ## Specification Compliance LDkit complies with the following specifications: @@ -120,6 +126,25 @@ LDkit complies with the following specifications: - [SPARQL 1.1 Update](https://www.w3.org/TR/2013/REC-sparql11-update-20130321/) - [SPARQL 1.1 Protocol](https://www.w3.org/TR/2013/REC-sparql11-protocol-20130321/) +## Citation + +If you are using LDkit in a scientific publication, we would appreciate a +citation of our work. + +```bibtex +@inproceedings{klima2023ldkit, + title = {LDkit: Linked Data Object Graph Mapping Toolkit for Web Applications}, + author = {Kl{\'\i}ma, Karel and Taelman, Ruben and Ne{\v{c}}ask{\`y}, Martin}, + booktitle = {International Semantic Web Conference}, + pages = {194--210}, + year = {2023}, + month = oct, + publisher = {Springer Nature Switzerland}, + isbn = {978-3-031-47243-5}, + url = {https://doi.org/10.1007/978-3-031-47243-5_11} +} +``` + ## License [MIT License](./LICENSE.md) diff --git a/docs/components/schema-generators.md b/docs/components/schema-generators.md index 3fdf3fc..5ca25e2 100644 --- a/docs/components/schema-generators.md +++ b/docs/components/schema-generators.md @@ -67,8 +67,8 @@ npx ldkit shexj-to-schema url https://ldkit.io/examples/person.shex.jsonld npx ldkit ``` -- ``: One of `context-to-schema`, `shex-to-schema`, or - `shacl-to-schema`. +- ``: One of `context-to-schema`, `shexc-to-schema`, or + `shexj-to-schema`. - ``: Defines how the input is provided. Possible values: