From 66099bc4632ba4801126a7bf8d3959050a8043e6 Mon Sep 17 00:00:00 2001
From: Niklas Kapelle <niklas@kapelle.org>
Date: Mon, 15 Dec 2025 21:29:31 +0100
Subject: [PATCH] added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f493cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+A rust driver for the [AS7265x](https://www.sparkfun.com/sparkfun-triad-spectroscopy-sensor-as7265x-qwiic.html) spectral sensor.
+
+Mostly based on the [aurduino driver](https://github.com/sparkfun/SparkFun_AS7265x_Arduino_Library) from SparkFun.
+
+# Usage
+
+See [examples](./examples/).
+Also the [datasheet](https://cdn.sparkfun.com/assets/c/2/9/0/a/AS7265x_Datasheet.pdf) can give some info.
+
+The driver requires a i2c device from `embedded_hal`. If you want to use the asynchronous version then enable the `async` feature flag.