From 0db6bde669f76f48a27b3c0d4a035d57d91184ca Mon Sep 17 00:00:00 2001 From: Andrew Moore Date: Fri, 14 Apr 2023 11:58:58 -0600 Subject: [PATCH] update README --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ffa40ea..e5331fc 100644 --- a/README.md +++ b/README.md @@ -21,22 +21,41 @@ end ## Usage -Simply call Excessibility.html_snapshot() and pass it either a Phoenix Conn or a -Wallaby Session. It will produce an html file named with the module and line -number it was called from. +Simply call Excessibility.html_snapshot() and pass it any of: -The module also includes a mix task that you can call to run pa11y against the -snapshots. `MIX_ENV=test mix excessibility` +- a Phoenix Conn +- a Wallaby Session +- a LiveViewTest View struct -## Default Configuration +It will produce an html file named with the module and line number of where it +was called from. + +You can pass an optional argument of `open_browser?: true` to open the snapshot +in your browser. +```elixir +thing +|> html_snapshot(open_browser?: true) ``` + +The module also includes a mix task that you can call to run +[pa11y](https://github.com/pa11y/pa11y) against the snapshots. +`MIX_ENV=test mix excessibility` + +## Default Configuration + +```elixir config :excessibility, :assets_task, "assets.deploy", :pa11y_path, "/assets/node_modules/pa11y/bin/pa11y.js", :output_path, "test/excessibility" ``` +## Pa11y Configuration + +See the [pa11y documentation](https://github.com/pa11y/pa11y#configuration) for +configuration options. + Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) and published on [HexDocs](https://hexdocs.pm). Once published, the docs can be found at