Add Accessibility Check to README

takahirom · Nov 20, 2024 · 927424b · 927424b
1 parent 1079f38
commit 927424b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -927,6 +927,11 @@ If you are having trouble debugging your test, try Dump mode as follows.
 
 ![image](https://user-images.githubusercontent.com/1386930/226364158-a07a0fb0-d8e7-46b7-a495-8dd217faaadb.png)
 
+### Accessibility Check
+
+Roborazzi Accessibility Checks is a library that integrates accessibility checks into Roborazzi.
+Please refer to [Accessibility Check](https://github.com/takahirom/roborazzi/blob/main/roborazzi-accessibility-check/README.md)
+
 ### Roborazzi options
 
 Please check out [RoborazziOptions](https://github.com/takahirom/roborazzi/blob/main/include-build/roborazzi-core/src/commonJvmMain/kotlin/com/github/takahirom/roborazzi/RoborazziOptions.kt) for available Roborazzi options.

diff --git a/docs/topics/how_to_use.md b/docs/topics/how_to_use.md
@@ -604,6 +604,11 @@ If you are having trouble debugging your test, try Dump mode as follows.
 
 ![image](https://user-images.githubusercontent.com/1386930/226364158-a07a0fb0-d8e7-46b7-a495-8dd217faaadb.png)
 
+### Accessibility Check
+
+Roborazzi Accessibility Checks is a library that integrates accessibility checks into Roborazzi.
+Please refer to [Accessibility Check](https://github.com/takahirom/roborazzi/blob/main/roborazzi-accessibility-check/README.md)
+
 ### Roborazzi options
 
 Please check out [RoborazziOptions](https://github.com/takahirom/roborazzi/blob/main/include-build/roborazzi-core/src/commonJvmMain/kotlin/com/github/takahirom/roborazzi/RoborazziOptions.kt) for available Roborazzi options.
diff --git a/roborazzi-accessibility-check/README.md b/roborazzi-accessibility-check/README.md
@@ -1,5 +1,8 @@
 # Roborazzi Acessibility Checks
 
+Roborazzi Accessibility Checks is a library that integrates accessibility checks into Roborazzi.
+It uses [ Accessibility Test Framework](https://github.com/google/Accessibility-Test-Framework-for-Android) to check accessibility.
+
 ## How to use
 
 ### Add dependencies
@@ -29,7 +32,7 @@
   )
 ```
 
-### Add a11y checks
+### Add accessibility checks
 
 ```kotlin
 composeTestRule.onNodeWithTag("nothard").checkRoboAccessibility(