Skip to content
This repository was archived by the owner on Jan 4, 2024. It is now read-only.

Commit a4beab3

Browse files
committed
Documentation improvements
1 parent 1264d02 commit a4beab3

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,7 @@ Note: if you are using this library in a Django project, please refer to the [us
130130

131131
An absolute path to the directory which contains your node_modules directory.
132132

133-
This setting must be defined to start either a host or manager.
134-
135-
Default: `None`
133+
Default: `os.getcwd() # Your current working directory`
136134

137135

138136
### CONFIG_FILE
@@ -155,14 +153,14 @@ Default: `False`
155153

156154
### PATH_TO_NODE
157155

158-
A path to a node or io.js binary
156+
A path to a `node` binary.
159157

160158
Default: `'node'`
161159

162160

163161
### BIN_PATH
164162

165-
A path to the binary used to control hosts and managers.
163+
A path to the `js-host` binary used to control hosts and managers.
166164

167165
If the path is relative, it is appended to the SOURCE_ROOT setting
168166

@@ -179,34 +177,34 @@ Default: `10.0`
179177

180178
### CONNECT_ONCE_CONFIGURED
181179

182-
Indicates that once `js_host` has been configured, it should attempt to connect to a
180+
Indicates that once this library has been configured, it should attempt to connect to a
183181
host.
184182

185-
This setting enables any config or connection errors to be raised during startup,
186-
rather than during runtime. It also enables connections to managed hosts to be
187-
preserved between restarts of your python process.
183+
This setting enables any config or connection errors to be raised during startup rather
184+
than runtime. It also enables connections to managed hosts to be preserved between
185+
restarts of your python process.
188186

189-
If you want to run multiple hosts and/or control the connection process, set this
190-
to `False`. Be aware that if you set it to `False`, managed hosts may not preserve
191-
connections when your python process restarts.
187+
If you want to run multiple hosts and/or control the connection process, set this to
188+
`False`, but be aware that managed hosts may not preserve connections when your python process
189+
restarts.
192190

193191
Default: `True`
194192

195193

196-
### URL_OVERRIDE
197-
198-
Overrides the root url which requests are sent to.
194+
### ROOT_URL
199195

200-
By default, the root url is inferred from the config that the host generates from your file.
196+
Overrides the root url which requests are sent to. By default, the root url is inferred from
197+
the config that the host generates from your config file and the js-host defaults.
201198

202-
If you want to route requests, set it to a string such as `'http://127.0.0.1:9009'`.
199+
If you want to route requests manually to a host, set it to a string such as
200+
`'http://127.0.0.1:9009'`.
203201

204202
Default: `None`
205203

206204

207205
### VERBOSITY
208206

209-
Indicates how much information the host should print the terminal. By default this
207+
Indicates how much information the host should print the terminal. By default the library
210208
will print to the terminal whenever processes are started or connected to.
211209

212210
If you want to suppress all output, set it to `js_host.verbosity.SILENT`.

0 commit comments

Comments
 (0)