From 2955772885e54e3f81409e0361c5435068ba44c1 Mon Sep 17 00:00:00 2001
From: johntalton <johntalton@gmail.com>
Date: Thu, 27 Jun 2024 04:03:26 -0400
Subject: [PATCH] read this

---
 README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e9f8d63..46299b5 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,26 @@
-# I²C Bus via MCP2221
+# I²C Bus MCP2221
+
+An [I²C interface](https://github.com/johntalton/and-other-delights) `I2CBus` implementation over [MCP2221](https://github.com/johntalton/mcp2221)
 
-A `I2CBus` implementation over `mcp2221` I²C interface
 
 [![npm Version](http://img.shields.io/npm/v/@johntalton/i2c-bus-mcp2221.svg)](https://www.npmjs.com/package/@johntalton/i2c-bus-mcp2221)
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/johntalton/i2c-bus-mcp2221)
 ![CI](https://github.com/johntalton/i2c-bus-mcp2221/workflows/CI/badge.svg?branch=master&event=push)
-![CodeQL](https://github.com/johntalton/i2c-bus-mcp2221/workflows/CodeQL/badge.svg)
 ![GitHub](https://img.shields.io/github/license/johntalton/i2c-bus-mcp2221)
 [![Downloads Per Month](http://img.shields.io/npm/dm/@johntalton/i2c-bus-mcp2221.svg)](https://www.npmjs.com/package/@johntalton/i2c-bus-mcp2221)
 ![GitHub last commit](https://img.shields.io/github/last-commit/johntalton/i2c-bus-mcp2221)
-[![Package Quality](https://npm.packagequality.com/shield/%40johntalton%2Fi2c-bus-mcp2221.svg)](https://packagequality.com/#?package=@johntalton/i2c-bus-mcp2221)
+
+#
+
+```js
+
+import { MCP2221 } from '@johntalton/mcp2221'
+import { I2CBusMCP2221 } from '@johntalton/i2c-bus-mcp2221'
+
+const hidDevice = /* navigator.hid.request ... */
+const source = new WebHIDStreamSource(hidDevice) // or NodeHIDStreamSource
+const device = MCP2221.from(source)
+const bus = I2CBusMCP2221.from(device)
+
+// bus.readI2CBlock(...) and friends
+```
\ No newline at end of file