Skip to content

Commit 782cf09

Browse files
committed
doc: lint and spellcheck README.md
Closes #153 Closes #135 Signed-off-by: Ryan Graham <[email protected]>
1 parent 40a9caf commit 782cf09

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ with a few Node specific changes.
1313

1414
Install the command line tool
1515

16-
$ npm install -g foreman
16+
npm install -g foreman
1717

1818
Get usage
1919

20-
$ nf --help
20+
nf --help
2121

2222
## Deviations from the original Foreman
2323

24-
* Each worker has an additional automatic environment variable,
25-
`FOREMAN_WORKER_NAME`, that contains the process name and worker number.
26-
* example: `web.1`, `worker.1`
24+
* Each worker has an additional automatic environment variable,
25+
`FOREMAN_WORKER_NAME`, that contains the process name and worker number.
26+
* example: `web.1`, `worker.1`
2727

2828
### How to Contribute
2929

@@ -42,13 +42,13 @@ You are free to add features, or just help clean things up.
4242

4343
Node Foreman can be run with as little as `nf start`, as long as `npm start` has been defined.
4444
For more complicated applications you will want to define a `Procfile` for your various server
45-
processes and and a `.env` file to preload environmental variables.
45+
processes and an `.env` file to pre-load environmental variables.
4646

4747
Your module directory should end up looking like the following:
4848

4949
![List Foreman Directory](https://raw.github.com/strongloop/node-foreman/master/assets/foreman-ls.png)
5050

51-
Once your Procfile is defined, run your application with `nf start`:
51+
Once your `Procfile` is defined, run your application with `nf start`:
5252

5353
![Start Foreman](https://raw.github.com/strongloop/node-foreman/master/assets/foreman-start.png)
5454

@@ -107,9 +107,9 @@ There is no need to specify which type of file you wish to use.
107107

108108
#### The PATH environment variable
109109

110-
The `PATH` variable is given special treament and is always read
110+
The `PATH` variable is given special treatment and is always read
111111
from the environment that the `nf` command has been executed from,
112-
rather than a `.env` file. To set a different `PATH` execute
112+
rather than your `.env` file. To set a different `PATH` execute
113113
`nf` with the `PATH` variable set appropriately.
114114

115115
```bash
@@ -131,7 +131,6 @@ port bindings, and other passwords.
131131
Tasks or commands that require the environment variables from the `.env` file
132132
can be initiated by using `nf run <command>`.
133133

134-
135134
### Advanced Usage
136135

137136
Node Foreman lets you start multiple jobs of the same type:
@@ -188,12 +187,13 @@ directory, or have foreman do it for you:
188187
Start and stop your jobs with
189188

190189
$ sudo start foreman
190+
Starting foreman... ok
191191
$ sudo stop foreman
192192

193193
The export will occur with whatever environmental variables are
194194
listed in the .env file.
195195

196-
### Systemd Support
196+
### systemd Support
197197

198198
_This section is beta_
199199

@@ -242,19 +242,19 @@ use `-a <JOBNAME>` and manage your jobs with `sudo start <JOBNAME>`.
242242
## Reverse Proxy
243243

244244
Node.js processes are supposed to be stateless.
245-
Application scale by starting multiple processes that either share a socket,
245+
Applications scale by starting multiple processes that either share a socket,
246246
or sit behind a load balancer.
247247
Node Foreman can help you test the parallel capabilities of your application
248-
by spawning multiple processes behind a round-robin proxy automatically.
248+
by spawning multiple processes behind a round-robin proxy.
249249

250-
$ nf start -x 8888 web=5
251-
[OKAY] Starting Proxy Server 8888 -> 5000-5004
250+
$ nf start -x 8888 web=5
251+
[OKAY] Starting Proxy Server 8888 -> 5000-5004
252252

253253
Access your application from port `8888` and the connections will be balanced
254254
across the servers started from ports `5000` - `5004`.
255255

256256
If your application gets its port number from `process.env.PORT` the proxy
257-
setup will ocurr automatically.
257+
setup will happen automatically.
258258

259259
### Multiple Reverse Proxies
260260

@@ -275,15 +275,15 @@ It does however allow proxies to be bound to lower ports, such as port 80.
275275

276276
If you require access to a privileged port, start Node Foreman with `sudo`:
277277

278-
$ sudo nf start -x 80 web=5
279-
[OKAY] Starting Proxy Server 80 -> 5000-5004
278+
$ sudo nf start -x 80 web=5
279+
[OKAY] Starting Proxy Server 80 -> 5000-5004
280280

281281
Your application will then be accessible via port 80, but it will be running as root.
282282

283283
## Forward Proxy
284284

285285
Local development and testing has huge advantages,
286-
but sometimes one needs to test web applications agains their real-world domain name.
286+
but sometimes one needs to test web applications against their real-world domain name.
287287
Editing `/etc/hosts` is a pain however, and error prone.
288288

289289
Node Foreman can start up an HTTP forward proxy which your browser can route requests through.

0 commit comments

Comments
 (0)