Skip to content

Commit 82a8df2

Browse files
achingbrainhugomrdias
authored andcommitted
docs: fix broken links in readme (#444)
Generated anchors are lower case.
1 parent 995d041 commit 82a8df2

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,15 +105,15 @@ await server.stop()
105105
### `createFactory([options], [overrides])`
106106
Creates a factory that can spawn multiple controllers and pre-define options for them.
107107

108-
- `options` **[ControllerOptions](#ControllerOptions)** Controllers options.
109-
- `overrides` **[ControllerOptionsOverrides](#ControllerOptionsOverrides)** Pre-defined options overrides per controller type.
108+
- `options` **[ControllerOptions](#controlleroptions)** Controllers options.
109+
- `overrides` **[ControllerOptionsOverrides](#controlleroptionsoverrides)** Pre-defined options overrides per controller type.
110110

111111
Returns a **[Factory](#factory)**
112112

113113
### `createController([options])`
114114
Creates a controller.
115115

116-
- `options` **[ControllerOptions](#ControllerOptions)** Factory options.
116+
- `options` **[ControllerOptions](#controlleroptions)** Factory options.
117117

118118
Returns **Promise<[Controller](#controller)>**
119119

@@ -137,7 +137,7 @@ Returns **Promise<String>** - Path to the repo.
137137

138138
#### `spawn([options])`
139139
Creates a controller for a IPFS node.
140-
- `options` **[ControllerOptions](#ControllerOptions)** Factory options.
140+
- `options` **[ControllerOptions](#controlleroptions)** Factory options.
141141

142142
Returns **Promise<[Controller](#controller)>**
143143

@@ -151,7 +151,7 @@ Class controller for a IPFS node.
151151

152152
#### `new Controller(options)`
153153

154-
- `options` **[ControllerOptions](#ControllerOptions)**
154+
- `options` **[ControllerOptions](#controlleroptions)**
155155

156156
#### `path`
157157
**String** Repo path.
@@ -220,9 +220,9 @@ Returns **Promise<string>**
220220
Type: [Object]
221221

222222
#### Properties
223-
- `js` **[[ControllerOptions](#ControllerOptions)]** Pre-defined defaults options for **JS** controllers these are deep merged with options passed to `Factory.spawn(options)`.
224-
- `go` **[[ControllerOptions](#ControllerOptions)]** Pre-defined defaults options for **Go** controllers these are deep merged with options passed to `Factory.spawn(options)`.
225-
- `proc` **[[ControllerOptions](#ControllerOptions)]** Pre-defined defaults options for **Proc** controllers these are deep merged with options passed to `Factory.spawn(options)`.
223+
- `js` **[[ControllerOptions](#controlleroptions)]** Pre-defined defaults options for **JS** controllers these are deep merged with options passed to `Factory.spawn(options)`.
224+
- `go` **[[ControllerOptions](#controlleroptions)]** Pre-defined defaults options for **Go** controllers these are deep merged with options passed to `Factory.spawn(options)`.
225+
- `proc` **[[ControllerOptions](#controlleroptions)]** Pre-defined defaults options for **Proc** controllers these are deep merged with options passed to `Factory.spawn(options)`.
226226

227227

228228
### ControllerOptions

0 commit comments

Comments
 (0)