From 3d7c88b4cb4283d774f996ce940c985994640433 Mon Sep 17 00:00:00 2001
From: Robert Sammelson <robert@sammelson.com>
Date: Sat, 20 May 2023 00:20:46 -0400
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9992303
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# `obd2`
+
+This library provides a user-friendly interface to automatically configure an
+[ELM327](https://github.com/rsammelson/obd2/blob/master/docs/ELM327DSH.pdf)
+[OBD-II](https://en.wikipedia.org/wiki/OBD-II) to UART interface through an FTDI UART to USB interface (the entire
+setup is easily available online as an OBD-II to USB interface), and then send commands and receive data from a
+vehicle.
+
+## Usage
+
+```rs
+use obd2::{commands::Obd2DataRetrieval, device::Elm327, Obd2};
+
+fn main() -> Result<(), obd2::Error> {
+    let mut device = Obd2::<Elm327>::default();
+    println!("VIN: {}", device.get_vin()?);
+    Ok(())
+}
+```
+
+See the docs for more: https://docs.rs/obd2/