Skip to content

Added CITATION file and minimum requirements #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karelklima merged 3 commits into from
Jun 30, 2025
Merged

Added CITATION file and minimum requirements #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d6ea65
Added CITATION file
karelklima Jun 30, 2025
2a24eda
Updated README with minimum requirements and citation
karelklima Jun 30, 2025
c88fcb8
Updated docs
karelklima Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions docs/components/schema-generators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ npx ldkit shexj-to-schema url https://ldkit.io/examples/person.shex.jsonld
npx ldkit <command> <method> <input>
```

- `<command>`: One of `context-to-schema`, `shex-to-schema`, or
`shacl-to-schema`.
- `<command>`: One of `context-to-schema`, `shexc-to-schema`, or
`shexj-to-schema`.

- `<method>`: Defines how the input is provided. Possible values:

Expand Down