Skip to content

Commit

Permalink
README.md: Add DOI and citation guide
Browse files Browse the repository at this point in the history
Signed-off-by: Boxuan Li <[email protected]>
  • Loading branch information
li-boxuan committed Feb 6, 2025
1 parent 46a971a commit 1cee599
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ can support thousands of concurrent users, complex traversals, and analytic grap
[![Mentioned in Awesome Bigtable][awesome-shield]][awesome-link]
[![CII Best Practices][bestpractices-shield]][bestpractices-link]
[![Codacy Badge][codacy-shield]][codacy-link]
[![DOI][doi-shield]][doi-link]

[actions-shield]: https://img.shields.io/github/actions/workflow/status/JanusGraph/janusgraph/ci-core.yml?branch=master
[actions-link]: https://github.com/JanusGraph/janusgraph/actions
Expand All @@ -33,6 +34,8 @@ can support thousands of concurrent users, complex traversals, and analytic grap
[codecov-link]:https://codecov.io/gh/JanusGraph/janusgraph
[docker-pulls-img]: https://img.shields.io/docker/pulls/janusgraph/janusgraph.svg
[docker-hub-url]: https://hub.docker.com/r/janusgraph/janusgraph
[doi-shield]: https://zenodo.org/badge/DOI/10.5281/zenodo.14807604.svg
[doi-link]: https://doi.org/10.5281/zenodo.14807604

## Learn More

Expand Down Expand Up @@ -142,3 +145,18 @@ The following users have deployed JanusGraph in production.
* [Red Hat](https://www.redhat.com/) - [application migration and assessment tool](https://developers.redhat.com/products/rhamt/overview/) built on [Windup](https://github.com/windup/windup)
* [Times Internet](https://timesinternet.in)
* [Uber](https://uber.com)

## Cite

If you use JanusGraph in your research, please cite it using this metadata:

```
@software{janusgraph_2024,
title = {JanusGraph: an open-source, distributed graph database},
author = {{JanusGraph Contributors}},
year = {2024},
version = {1.1.0},
publisher = {Zenodo},
doi = {10.5281/zenodo.14807604}
}
```

0 comments on commit 1cee599

Please sign in to comment.