-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update main page of documentation to reflect multiple integration layers
- Loading branch information
Showing
1 changed file
with
2 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |