Add more instructions to the README
This commit is contained in:
parent
e882a980c5
commit
8f57239700
37
README.md
37
README.md
|
@ -2,26 +2,37 @@ King of Time CLI
|
|||
=================
|
||||
|
||||
<!-- toc -->
|
||||
* [Installation](#installation)
|
||||
* [Set Tokens](#set-tokens)
|
||||
* [Usage](#usage)
|
||||
* [Commands](#commands)
|
||||
<!-- tocstop -->
|
||||
# Installation
|
||||
|
||||
From the same directory as this README:
|
||||
|
||||
```sh-session
|
||||
$ npm install
|
||||
$ npm link
|
||||
```
|
||||
|
||||
# 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.
|
||||
|
||||
* `KINGOFTIME_TOKEN`
|
||||
* `KINGOFTIME_USER_TOKEN`
|
||||
|
||||
# Usage
|
||||
|
||||
TODO add instructions for setting tokens.
|
||||
|
||||
<!-- usage -->
|
||||
```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
|
||||
```
|
||||
<!-- usagestop -->
|
||||
# Commands
|
||||
<!-- commands -->
|
||||
* [`kot checkin`](#kot-checkin)
|
||||
|
|
Loading…
Reference in New Issue