From 3cf320aa0ad49b9ceaa6aa45b313d43d6c2c8b02 Mon Sep 17 00:00:00 2001 From: Nicholas Entin Date: Tue, 15 Aug 2023 01:26:28 -0700 Subject: [PATCH] Update main page of documentation to reflect multiple integration layers --- Documentation/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/README.md b/Documentation/README.md index 2c963658..e365233e 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -1,7 +1,7 @@ -AccessibilitySnapshot is split into two main layers: the core accessibility parser and an integration layer using a snapshotting engine. This is reflected in the pod's two subspecs: `Core` and `iOSSnapshotTestCase`. +AccessibilitySnapshot is split into two layers: the core accessibility parser and an integration layer using a snapshotting engine. This is reflected in the pod's three subspecs: the `Core` subspec for the accessibility parser, and the `iOSSnapshotTestCase` and `SnapshotTesting` subspecs for the two available integration layers. The `Core` subspec contains the accessibility parser and utilities for generating a container view to snapshot that includes a legend showing each of the accessibility elements in the view. The [Core Architecture](Core-Architecture.md) page contains more details on the different components that make up this subspec. -The `iOSSnapshotTestCase` subspec contains an integration layer built on top of the parser that provides simple snapshotting via the iOSSnapshotTestCase framework. Instructions for getting started with this can be found in the [Usage](https://github.com/cashapp/AccessibilitySnapshot/blob/master/README.md#usage) section of the README. +The other two subspecs contain integration layers built on top of the parser that provide simple snapshotting via the iOSSnapshotTestCase and SnapshotTesting framework, respectively. Instructions for getting started with these can be found in the [Usage](https://github.com/cashapp/AccessibilitySnapshot/blob/master/README.md#usage) section of the README. Alternative integration layers can be built on top of the core parser by depending only on the `Core` subspec. A list of these can be found in the [Extensions](https://github.com/cashapp/AccessibilitySnapshot/blob/master/README.md#extensions) section of the README.