Skip to content

Commit

Permalink
chore: clean README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
waitingsong committed Feb 14, 2020
1 parent 9727bf3 commit 097dd0a
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,18 @@ startCluster(options, () => {

## Options

| Param | Type | Description |
| --------------- | --------------- | ----------------------------------------------------------------------------- |
| baseDir | `String` | directory of application |
| framework | `String` | specify framework that can be absolute path or npm package |
| plugins | `Object` | plugins for unittest |
| workers | `Number` | numbers of app workers |
| sticky | `Boolean` | sticky mode server |
| port | `Number` | port |
| https | `Object` | start a https server, note: `key` / `cert` / `ca` should be full path to file |
| require | `Array\|String` | will inject into worker/agent process |
| pidFile | `String` | will save master pid to this file |
| [serialization] | `json|advanced` | default: 'json'. 'advanced' requires Node.js >= 10.16.0 |
| Param | Type | Description |
| ------------- | --------------- | ----------------------------------------------------------------------------- |
| baseDir | `String` | directory of application |
| framework | `String` | specify framework that can be absolute path or npm package |
| plugins | `Object` | plugins for unittest |
| workers | `Number` | numbers of app workers |
| sticky | `Boolean` | sticky mode server |
| port | `Number` | port |
| https | `Object` | start a https server, note: `key` / `cert` / `ca` should be full path to file |
| require | `Array\|String` | will inject into worker/agent process |
| pidFile | `String` | will save master pid to this file |
| serialization | `json|advanced` | default: 'json'. 'advanced' requires Node.js >= 12.16.0 or >= 13.2.0 |

## Env

Expand All @@ -72,5 +72,3 @@ EGG_AGENT_CLOSE_TIMEOUT: agent worker boot timeout value
## License

[MIT](LICENSE)

[serialization]:https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V12.md#advanced-serialization-for-ipc

0 comments on commit 097dd0a

Please sign in to comment.