Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update options listed in README #184

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update options listed in README #184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,19 @@ The available options are:
```
Usage: slackin [options] <team-id> <api-token>

Options:

-h, --help output usage information
-V, --version output the version number
-p, --port <port> Port to listen on [$PORT or 3000]
-h, --hostname <hostname> Hostname to listen on [$HOSTNAME or 0.0.0.0]
-c, --channels [<chan>] One or more comma-separated channel names to allow single-channel guests [$SLACK_CHANNELS]
-c, --channel <chan> Single channel guest invite (deprecated) [$SLACK_CHANNEL]
-i, --interval <int> How frequently (ms) to poll Slack [$SLACK_INTERVAL or 5000]
-P, --path Path to serve slackin under
-s, --silent Do not print out warns or errors
-c, --css <file> Full URL to a custom CSS file to use on the main page
Options:

-h, --help output usage information
-V, --version output the version number
-p, --port <port> Port to listen on [$PORT or 3000]
-h, --hostname <hostname> Hostname to listen on [$HOSTNAME or 0.0.0.0]
-c, --channels [<chan>] One or more comma-separated channel names to allow single-channel guests [$SLACK_CHANNELS]
-c, --channel <chan> Single channel guest invite (deprecated) [$SLACK_CHANNEL]
-i, --interval <int> How frequently (ms) to poll Slack [$SLACK_INTERVAL or 5000]
-P, --path <path> Path to serve slackin under
-s, --silent Do not print out warns or errors
-C, --coc <coc> Full URL to a CoC that needs to be agreed to
-c, --css <file> Full URL to a custom CSS file to use on the main page
```

**Important: if you use Slackin in single-channel mode, you'll only be
Expand Down