Skip to content

Commit

Permalink
Merge pull request #154 from cashapp/entin/collapse-install-sections-…
Browse files Browse the repository at this point in the history
…readme

Make how to install sections in README collapsible
  • Loading branch information
NickEntin authored Oct 3, 2023
2 parents a5ce2b6 + 7034d9a commit baca5d9
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ AccessibilitySnapshot makes it simple to add regression tests for accessibility

By default, AccessibilitySnapshot uses [SnapshotTesting](https://github.com/pointfreeco/swift-snapshot-testing) to record snapshots and perform comparisons. The framework also includes support for using [iOSSnapshotTestCase](https://github.com/uber/ios-snapshot-test-case) as the snapshotting engine instead. Before setting up accessibility snapshot tests, make sure your project is set up for standard snapshot testing. Accessibility snapshot tests require that the test target has a host application. See the [Extensions](#extensions) section below for a list of other available snapshotting options.

### CocoaPods
<details>
<summary><h3>CocoaPods</h3></summary>

Install with [CocoaPods](https://cocoapods.org) by adding the following to your `Podfile`:

Expand All @@ -34,8 +35,10 @@ Alternatively, if you wish to use [iOSSnapshotTestCase](https://github.com/uber/
```ruby
pod 'AccessibilitySnapshot/iOSSnapshotTestCase'
```
</details>

### Swift Package Manager
<details>
<summary><h3>Swift Package Manager</h3></summary>

Install with [Swift Package Manager](https://swift.org/package-manager/) by adding the following to your `Package.swift`:

Expand Down Expand Up @@ -71,14 +74,17 @@ targets: [
.testTarget(name: "MyAppTests", dependencies: ["MyApp", "FBSnapshotTestCase+Accessibility"])
]
```
</details>

### Carthage
<details>
<summary><h3>Carthage</h3></summary>

Only the core accessibility parser (not the snapshot integration layers) can be installed via Carthage. To install AccessibilitySnapshotCore via [Carthage](https://github.com/Carthage/Carthage), add the following to your `Cartfile`:

```ogdl
github "cashapp/AccessibilitySnapshot"
```
</details>

## Usage

Expand Down

0 comments on commit baca5d9

Please sign in to comment.