adds documentation for module

localgovdrupal · Jun 26, 2024 · b646c69 · b646c69
1 parent 5dab59c
commit b646c69
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,9 +2,16 @@
 
 Integrates the [Sa11y accessibility checker](https://sa11y.netlify.app/) into LocalGov Drupal.
 
-## Maintainers
+## Using
+Enbale the module like any other Drupal module.
+Set what roles can use the Sa11y widget via the `use_localgov_sa11y` permission.
+
+The module is set to only work on pages that are not using the admin theme.
 
-This project is currently maintained by: 
+Now when you visit any page on your site using your frontend theme, you should see the Sa11y widget in the bottom left corner.
+
+## Maintainers
+This project is currently maintained by:
 
  - Mark Conroy https://github.com/markconroy
  - Maria Young https://github.com/msayoung
diff --git a/localgov_sa11y.permissions.yml b/localgov_sa11y.permissions.yml
@@ -1,3 +1,3 @@
 use_localgov_sa11y:
-  title: 'Use localgov_sa11y'
+  title: 'Use LocalGov Sa11y'
   restrict access: true