Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated the readme with the export documentation

  • Loading branch information...
commit db78e6bbf22f5e066fcc96ec100d93bf9cca6fb2 1 parent 468e5f1
@liangzan authored
Showing with 46 additions and 3 deletions.
  1. +46 −3 README.md
View
49 README.md
@@ -2,8 +2,6 @@
Forewoman is a Node.js port of [foreman](https://github.com/ddollar/foreman), with the added feature of hot code reloading. Credits to [node-supervisor](https://github.com/isaacs/node-supervisor) for inspiring the hot code reloading implementation.
-Export is not completed yet. It will be available from 0.2.x
-
Forewoman is extracted from the code base of [Notifymode](http://notifymode.com)
## Caveats
@@ -28,7 +26,7 @@ If it is a global install, __forewoman__ should be available from your PATH.
## Usage
-### SYNOPSIS
+### SYNOPSIS for start
forewoman start [OPTION]
@@ -60,6 +58,51 @@ Specify which port to use as the base for this application. Should be a multiple
#### -w, --watch
Specify the files to watch. If the files are modified, forewoman will restart the process. The value passed in should be in the format process=/path/to/file,process=/path/to/file
+### SYNOPSIS for export
+
+ forewoman export <format> [location] [OPTION]
+
+forewoman export is used to export your application to another process management format
+
+An location to export can be passed as an argument. This argument'may be either required or optional depending on the export format.
+
+### Formats
+
+- runit (location not optional)
+- upstart (location not optional)
+- inittab (coming)
+- supervisord (coming)
+- monit (coming)
+
+### Options
+
+#### -a, --app
+Use this name rather than the application\'s root directory name as the name of the application when exporting.
+
+#### -c, --concurrency
+Specify the number of each process type to run. The value passed in should be in the format process=num,process=num
+
+#### -l, --log
+Specify the directory to place process logs in.
+
+#### -p, --port
+Specify which port to use as the base for this application. Should be a multiple of 1000.
+
+#### -u, --user
+Specify the user the application should be run as. Defaults to the app name
+
+#### -t, --template
+Specify an alternate template to use for creating export files. Read the templates directory for examples. Specify your option by template_name=/path/to/template. Eg. runit's log_run.mustache can be replaced by "log_run=/path/to/alt.mustache" The templates should be a [Mustache](https://github.com/janl/mustache.js/) template
+
+#### -d, --directory
+Specify an alternate application root. This defaults to the directory containing the Procfile.
+
+#### -e, --env
+Specify an alternate environment file. You can specify more than one file by using: --env file1,file2.
+
+#### -f, --procfile
+Specify an alternate location for the application's Procfile. This file's containing directory will be assumed to be the root directory of the application.
+
## License
Copyright (c) 2012 Wong Liang Zan. MIT License
Please sign in to comment.
Something went wrong with that request. Please try again.