From 21cd45d2a098e9342c88a9859b7c8a98cb37771b Mon Sep 17 00:00:00 2001 From: Mark Skelton Date: Mon, 21 Mar 2022 13:41:22 -0500 Subject: [PATCH] Update README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 144eae7..2160cb6 100644 --- 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) +```