Skip to content

Commit

Permalink
[fix doc] More documentation around forever.startServer. Fixes #566.
Browse files Browse the repository at this point in the history
  • Loading branch information
indexzero committed Sep 6, 2014
1 parent dfed754 commit 250a4f8
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ In addition to using a Forever object, the forever module also exposes some usef
forever.startServer(child);
```

This method takes multiple `forever.Monitor` instances which are defined in the `forever-monitor` dependency.

### forever.load (config)
_Synchronously_ sets the specified configuration (config) for the forever module. There are two important options:

Expand Down Expand Up @@ -154,6 +156,9 @@ Cleans up any extraneous forever *.pid files that are on the target system. This
### forever.cleanLogsSync (processes)
Removes all log files from the root forever directory that do not belong to current running forever processes. Processes are the value returned from `Monitor.data` in `forever-monitor`.

### forever.startServer (monitor0, monitor1, ..., monitorN)
Starts the `forever` HTTP server for communication with the forever CLI. **NOTE:** This will change your `process.title`. This method takes multiple `forever.Monitor` instances which are defined in the `forever-monitor` dependency.

## Run Tests

``` bash
Expand Down

0 comments on commit 250a4f8

Please sign in to comment.