Skip to content

Commit aba1197

Browse files
Update README content (#4)
* Update content Update content * Add docs link and update content
1 parent 7077b9a commit aba1197

1 file changed

Lines changed: 20 additions & 13 deletions

File tree

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# AccessibilityDevTools
2-
A Swift Package Manager (SPM) command plugin and CLI tool that scans your iOS Swift codebase for accessibility issues using BrowserStack’s Accessibility DevTools rule engine.
2+
A Swift Package Manager (SPM) command plugin that scans your iOS Swift codebase for accessibility issues using BrowserStack’s Accessibility DevTools rule engine.
33

4-
AccessibilityDevTools enables static accessibility linting directly inside Xcode, via SwiftPM, or using the standalone BrowserStack CLI, helping teams catch WCAG violations early—before UI tests, QA, or production.
4+
AccessibilityDevTools enables static accessibility linting directly inside Xcode via SwiftPM, helping teams catch WCAG violations early—before UI tests, QA, or production.
55

66
---
77
## 🚀 Key Capabilities
@@ -12,8 +12,8 @@ AccessibilityDevTools enables static accessibility linting directly inside Xcode
1212

1313
---
1414
## Supported projects types
15-
1. Projects created with Swift package manager
16-
2. Projects created with XCode
15+
1. Projects created with XCode
16+
2. Projects created with Swift package manager
1717

1818
---
1919
## Authentication
@@ -27,13 +27,13 @@ AccessibilityDevTools enables static accessibility linting directly inside Xcode
2727
4. To set these variables, add the appropriate export commands to your shell configuration file:
2828
* **Zsh**: Add the following lines to your `~/.zshrc` file:
2929
```zsh
30-
export BROWSERSTACK_USERNAME="<your-username>"
31-
export BROWSERSTACK_ACCESS_KEY="<your-access-key>"
30+
export BROWSERSTACK_USERNAME=<your-username>
31+
export BROWSERSTACK_ACCESS_KEY=<your-access-key>
3232
```
3333
* **Bash**: Add the following lines to your `~/.bashrc` or `~/.bash_profile` file:
3434
```bash
35-
export BROWSERSTACK_USERNAME="<your-username>"
36-
export BROWSERSTACK_ACCESS_KEY="<your-access-key>"
35+
export BROWSERSTACK_USERNAME=<your-username>
36+
export BROWSERSTACK_ACCESS_KEY=<your-access-key>
3737
```
3838
* **Fish Shell**: Add the following lines to your ~/.config/fish/config.fish file:
3939
```fish
@@ -44,10 +44,10 @@ AccessibilityDevTools enables static accessibility linting directly inside Xcode
4444
---
4545
## Installation
4646
### 1. Projects created with XCode
47-
> Note: XCode projects don’t have a Package.swift file. However, the script will manage this for you. If you prefer not to do this or face any issues, you can use our CLI for linting instead.
47+
> Note: XCode projects don’t have a `Package.swift` file. However, the script will manage this for you. If you prefer not to do this or face any issues, you can use our [CLI](https://www.browserstack.com/docs/accessibility-dev-tools/xcode-linter#CLI) for linting instead.
4848

4949
#### Clone Script
50-
Run the following command at the <span style="color:red">root of your repository</span>
50+
Run the following command at the **root of your repository**
5151

5252
Zsh
5353
```zsh
@@ -63,6 +63,9 @@ Fish
6363
```fish
6464
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/fish/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
6565
```
66+
#### Disable Sandboxing
67+
- In Xcode, select first item (project root) in the left folder tree and go to Build Settings tab
68+
- Search for `sandbox` > Set `User script sandboxing` to “NO”
6669

6770
#### Add a Build Phase
6871
Repeat these steps for each target in your project
@@ -71,7 +74,7 @@ Repeat these steps for each target in your project
7174
2. Click + to create a new build phase. Name the newly created build phase to a name such as **BrowserStack Accessibility Linter**.
7275
![Build Phase](./resources/build-phase.png "Build Phase")
7376
3. Drag this newly created build phase above **Compile Sources** step
74-
4. Delete any existing code in the newly created build step and add the following code.
77+
4. Delete any existing code in the newly created build step and add the following code
7578
5. Add this script:
7679
```
7780
./browserstack-a11y-scan-spm.sh --include **/*.swift --non-strict
@@ -113,7 +116,7 @@ let package = Package(
113116
```
114117

115118
#### Clone Script
116-
Run the following command in the <span style="color:red;">root of your repository</span>
119+
Run the following command at the **root of your repository**
117120

118121
Zsh
119122
```zsh
@@ -130,11 +133,15 @@ Fish
130133
curl -L -o browserstack-a11y-scan-spm.sh "https://raw.githubusercontent.com/browserstack/AccessibilityDevTools/refs/heads/main/scripts/fish/spm.sh" && chmod 0775 browserstack-a11y-scan-spm.sh
131134
```
132135

136+
#### Disable Sandboxing
137+
- In Xcode, select first item (project root) in the left folder tree and go to Build Settings tab
138+
- Search for `sandbox` > Set `User script sandboxing` to “NO”
139+
133140
#### Add a Build Phase
134141
Repeat these steps for each target in your project
135142

136143
1. Select a target from the targets left sidebar and go to Build Phases tab
137-
2. Click + to create a new build phase. Name the newly created build phase to a name such as **BrowserStack Accessibility Linter**
144+
2. Click + to create a new build phase. Name the newly created build phase to a name such as **BrowserStack Accessibility Linter**.
138145
![Build Phase](./resources/build-phase.png "Build Phase")
139146
3. Drag this newly created build phase above **Compile Sources** step
140147
4. Delete any existing code in the newly created build step and add the following code.

0 commit comments

Comments
 (0)