From 50866ff170744a6e1f116b2947e7fd4bdf724994 Mon Sep 17 00:00:00 2001
From: Jake Ireland <jakewilliami@icloud.com>
Date: Sun, 6 Oct 2024 17:42:38 +1300
Subject: [PATCH] Add software citation source

---
 README.md    | 3 +++
 citation.bib | 7 +++++++
 2 files changed, 10 insertions(+)
 create mode 100644 citation.bib

diff --git a/README.md b/README.md
index 4df0c8e..59bf5cc 100644
--- 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
new file mode 100644
index 0000000..550d556
--- /dev/null
+++ 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}
+}
\ No newline at end of file