Add software citation source

jakewilliami · Oct 6, 2024 · 50866ff · 50866ff
1 parent 0f5d579
commit 50866ff
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -23,3 +23,6 @@ true
 
 The origin of this project comes from [`julia#38841`](https://github.com/JuliaLang/julia/issues/38841).
 
+## Citation
+
+If your research depends on HiddenFiles.jl, please consider giving us a formal citation: [`citation.bib`](./citation.bib).
diff --git a/citation.bib b/citation.bib
@@ -0,0 +1,7 @@
+@software{ireland2023hiddenfiles,
+  title={{HiddenFiles.jl}: A cross-platform library to determine if a file or directory is hidden},
+  author={Ireland, Jake W},
+  year={2023},
+  howpublished={\url{https://github.com/jakewilliami/HiddenFiles.jl}},
+  note={{Julia} package version 0.1.3}
+}