Commit 7068faafc54e465ef9e3fd206b89197e623f2386
Update readme
cel committed on 3/19/2017, 5:43:43 PMParent: a468209c4f9bcc7525a6218d3a9445ce673b3822
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -7,24 +7,21 @@ | ||
| 7 | 7 … | ```js |
| 8 | 8 … | var createSsbParty = require('ssb-party') |
| 9 | 9 … | ``` |
| 10 | 10 … | |
| 11 | -### `createSsbParty([[keys, ]opts, ]cb)` | |
| 11 … | +### `createSsbParty([opts, ]cb)` | |
| 12 | 12 … | |
| 13 | -optional arguments: | |
| 14 | - | |
| 15 | -- `keys`: an [ssb-keys][] instance | |
| 16 | -- `opts.host`: host to connect to or start the server on | |
| 17 | -- `opts.port`: port to connect to or start the server on | |
| 18 | -- `opts.appKey`: secret-stack capability key (Buffer) | |
| 13 … | +- `opts.keys`: an [ssb-keys][] instance. default loads from `~/.ssb/secret` | |
| 14 … | +- `opts.host`: host to connect to or start the server on. default `"localhost"` | |
| 15 … | +- `opts.port`: port to connect to or start the server on. default 8008 | |
| 16 … | +- `opts.appKey`: secret-stack capability key (Buffer). default sbot's appKey | |
| 19 | 17 … | - `opts.out`: where to put standard output of sbot |
| 20 | 18 … | - `opts.err`: where to put standard error of sbot |
| 21 | 19 … | |
| 22 | 20 … | `opts.out` and `opts.err` may be a file descriptor, or `"inherit"` to pass through to the controlling terminal, or `"ignore"` to discard. default is to log to a file, `~/.ssb/out.log`. |
| 23 | 21 … | |
| 24 | 22 … | Other properties of the `opts` object will be used as [ssb-config][] |
| 25 | -overrides, but if the server is already running, the existing server's config | |
| 26 | -will not be updated. | |
| 23 … | +overrides, but if the server is already running, these will not affect the existing server's config. | |
| 27 | 24 … | |
| 28 | 25 … | ### Example |
| 29 | 26 … | |
| 30 | 27 … | simplest case: connect to or start a local sbot: |
Built with git-ssb-web