Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit eded277

Browse files
authored
Update README.md
Move troubleshooting to installation section
1 parent b334a0c commit eded277

File tree

1 file changed

+18
-22
lines changed

1 file changed

+18
-22
lines changed

README.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,24 @@ as well as top-level type aliases, functions, and variables.
3030

3131
Run the following command to install using [Homebrew](https://brew.sh/):
3232

33-
```terminal
33+
```console
34+
$ brew install swiftdocorg/formulae/swift-doc
35+
```
36+
37+
If you already have `swift-doc` installed,
38+
run the following command to upgrade your installation:
39+
40+
```console
41+
$ brew upgrade swift-doc
42+
```
43+
44+
If installing or upgrading fails with the message
45+
*Error: Failed to download resource "swift-doc"*,
46+
try resetting your installation with the following commands:
47+
48+
```console
49+
$ brew uninstall swift-doc
50+
$ brew untap swiftdocorg/formulae
3451
$ brew install swiftdocorg/formulae/swift-doc
3552
```
3653

@@ -235,27 +252,6 @@ Here's an excerpt of the graph generated for Alamofire:
235252

236253
![Excerpt of swift-doc-api Diagram for Alamofire](https://user-images.githubusercontent.com/7659/73189318-0db0e880-40d9-11ea-8895-341a75ce873c.png)
237254

238-
## Troubleshooting
239-
240-
Having trouble with SwiftDoc? Have a look at this section for help.
241-
242-
### Homebrew: Failed to download resource "swift-doc"
243-
244-
If using Homebrew to install or upgrade SwiftDoc fails with a `404` error similar to this:
245-
246-
```bash
247-
curl: (22) The requested URL returned error: 404
248-
Error: Failed to download resource "swift-doc"
249-
```
250-
251-
Try untapping and reinstalling SwiftDoc:
252-
253-
```bash
254-
$ brew uninstall swift-doc
255-
$ brew untap swiftdocorg/formulae
256-
$ brew install swiftdocorg/formulae/swift-doc
257-
```
258-
259255
## GitHub Action
260256

261257
This repository also hosts a [GitHub Action][github actions]

0 commit comments

Comments
 (0)