Skip to content

Commit

Permalink
Updated usage guide
Browse files Browse the repository at this point in the history
The --limit flag on the create command wasn't being documented.
  • Loading branch information
MeLlamoPablo committed Jan 4, 2017
1 parent 88a1420 commit 75422c5
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions usage/usage-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,16 @@ The `create` commands is used (you guessed it) to create events. It takes two ar
* `name` is the name of the event. It can be anything you want, but be careful: if you have
spaces in your name, you must use either "double quotes" or 'single quotes'. Otherwise the bot
would only recognize the first word as the name.
* `time` is the date and time of the event, in this format: `DD/MM/YYYY HH:mm`. If the
`--timezone` flag is specified, the time is converted from that time zone to the default time
zone specified in `config.js:default_timezone`.
* `time` is the date and time of the event, in this format: `DD/MM/YYYY HH:mm`.

If the `--timestamp` flag is specified, this argument will be parsed as an
[UNIX Timestamp](https://en.wikipedia.org/wiki/Unix_time) instead of a date string.
It also accepts the following flags:

* `--limit` (alias `-l`) determines the maximum number of people that can attend the event. Once
the limit has been reached, further sign ups are rejected.
* `--timezone` (alias `-t`) determines the time zone in which the `time` argument is being
specified.
* `--timestamp` (alias `-u`), if passed, determines that the `time` is being passed as an
[UNIX Timestamp](https://en.wikipedia.org/wiki/Unix_time) instead of a date string.

Examples:

Expand Down

0 comments on commit 75422c5

Please sign in to comment.