diff --git a/README.md b/README.md index e7a2783..a970aae 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,41 @@ King of Time CLI * [Usage](#usage) +* [Installation](#installation) * [Commands](#commands) + # Usage -TODO add instructions for setting tokens. - - ```sh-session -$ npm install -g kingoftime-cli -$ kot COMMAND -running command... -$ kot (--version) -kingoftime-cli/0.0.0 darwin-x64 node-v18.15.0 -$ kot --help [COMMAND] -USAGE - $ kot COMMAND -... +$ kot checkin +TODO example output + +$ kot checkout +TODO example output ``` - + +# Installation + +From the same directory as this README: + +```sh-session +$ npm run build +$ npm link +``` + +Now the `kot` command should be available on your system. + +## Set Tokens + +You need to provide two tokens, which can be retrieved by inspecting the HTTP request to `/bprgateway` the +King of Time Web UI makes when submitting a check-in or check-out request. + +It is convenient to set these as the below environment variables, although they can also be passed as options +to the `checkin` and `checkout` commands. + +* `KINGOFTIME_TOKEN` +* `KINGOFTIME_USER_TOKEN` # Commands * [`kot checkin`](#kot-checkin)