From d17cd9cbbd950f769fc00f6501467e5d835ccd1a Mon Sep 17 00:00:00 2001
From: ZacJW <zac@zacjw.com>
Date: Sat, 15 Nov 2025 18:28:47 +0000
Subject: [PATCH] Add readme

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9c11ad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# `libburn-sys`
+
+Low-level Rust bindings for libburn.
+
+You can find out more about the libburnia project, of which libburn is a part, by visiting
+<https://dev.lovelyhq.com/libburnia/web/wiki>
+
+This version of libburn-sys is based on libburn 1.5.6
+
+## Requirements
+
+Currently, libburn-sys does not support statically linking libburn into your application, and may never do.
+Instead, **you must have libburn 1.5.6 or greater installed** on your system so libburn-sys can dynamically
+link to it.
+
+Bindings for libburn are pregenerated for libburn-sys, so you shouldn't need bindgen's dependencies
+installed to start using libburn-sys.