From 250a4f83f8d2da0c5aa81c6c0e8cdcbb9e9ce82c Mon Sep 17 00:00:00 2001 From: indexzero Date: Sat, 6 Sep 2014 00:23:38 -0400 Subject: [PATCH] [fix doc] More documentation around `forever.startServer`. Fixes #566. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ce93c85b..df3ba7e5 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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