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.