Skip to content

Commit 25970d7

Browse files
authored
docs: Added CITATION.cff, updated citation info (#73)
* Updated citation info, added DOI * Updated citation info, added DOI
1 parent 61af91f commit 25970d7

2 files changed

Lines changed: 43 additions & 0 deletions

File tree

CITATION.cff

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
cff-version: 1.2.0
2+
message: "If you use Vicinity in your research, please cite it as below."
3+
title: "Vicinity: Lightweight Nearest Neighbors with Flexible Backends"
4+
authors:
5+
- family-names: "Tulkens"
6+
given-names: "Stephan"
7+
- family-names: "van Dongen"
8+
given-names: "Thomas"
9+
doi: 10.5281/zenodo.17265874
10+
license: MIT
11+
url: "https://github.com/MinishLab/vicinity"
12+
repository-code: "https://github.com/MinishLab/vicinity"
13+
date-released: "2024-11-09"
14+
15+
preferred-citation:
16+
type: software
17+
title: "Vicinity: Lightweight Nearest Neighbors with Flexible Backends"
18+
authors:
19+
- family-names: "Tulkens"
20+
given-names: "Stephan"
21+
- family-names: "van Dongen"
22+
given-names: "Thomas"
23+
year: 2024
24+
publisher: Zenodo
25+
doi: 10.5281/zenodo.17265874
26+
url: "https://github.com/MinishLab/vicinity"
27+
license: MIT

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,3 +198,19 @@ pip install vicinity[voyager]
198198
## License
199199

200200
MIT
201+
202+
## Citing
203+
204+
If you use Vicinity in your research, please cite the following:
205+
206+
```bibtex
207+
@software{minishlab2024vicinity,
208+
author = {Stephan Tulkens and {van Dongen}, Thomas},
209+
title = {Vicinity: Lightweight Nearest Neighbors with Flexible Backends},
210+
year = {2024},
211+
publisher = {Zenodo},
212+
doi = {10.5281/zenodo.17265874},
213+
url = {https://github.com/MinishLab/vicinity},
214+
license = {MIT}
215+
}
216+
```

0 commit comments

Comments
 (0)