Update README.md

Widen · Mar 21, 2022 · 21cd45d · 21cd45d
1 parent e7db117
commit 21cd45d
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -22,4 +22,10 @@ yarn add axe-reporter-html
 
 ## Usage
 
-TODO
+This package exports a single function that you can use to create an HTML report from an `AxeResults` object.
+
+```js
+import createHTMLReport from 'axe-reporter-html'
+
+const html = await createHTMLReport(results)
+```