From d30012746c3e99a915ae6f85e6305802cb8928a3 Mon Sep 17 00:00:00 2001
From: Andy Killorin <37423245+Speedy6451@users.noreply.github.com>
Date: Fri, 14 Mar 2025 22:04:57 -0400
Subject: [PATCH] added a readme

---
 readme.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..bcb8080
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,31 @@
+# `adis1647x`
+
+no_std driver for the Analog Devices [adis1647](https://www.mouser.com/new/analog-devices/adi-adis1647-imus/) family of IMUs. Currently only the adis16475 is implemented.
+
+
+### Usage
+
+You need an embedded_hal_async spi driver
+
+```rust
+
+use adis1647x::*;
+use adis1647x::delta::*;
+
+async fn main() -> Result<(), SomeSpiError> {
+    let bus = some_spi();
+    
+    let imu = ADIS1647X::new(bus).await?;
+    
+    let mut angle: DeltaAngle = Default::default();
+    
+    loop {
+        data_ready_rising_edge().await;
+        
+        let (delta_angle, _) = imu.deltas().await?;
+        
+        angle += delta_angle;
+        
+        println!("yaw: {} degrees", angle.angles().y);
+    }
+```