Skip to content

Commit 1208eea

Browse files
Merge pull request #2 from timehook/readme
Filled README.md
2 parents 45764bb + e62f6e5 commit 1208eea

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Timehook CLI client
2+
3+
[![Build Status](https://travis-ci.org/timehook/cli-client.svg?branch=master)](https://travis-ci.org/timehook/cli-client)
4+
5+
Timehook CLI client is a client implementation to use with [https://api.timehook.io](https://api.timehook.io)
6+
7+
## Usage
8+
9+
##### Compile on your own
10+
11+
1. Download or clone the repo.
12+
2. Build executable `go build -o bin/timehook cmd/main/timehook.go`
13+
14+
## Example
15+
16+
Set up the api key as environment variable
17+
18+
export TIMEHOOK_KEY=__YOUR_KEY__
19+
20+
21+
With defaults:
22+
23+
./bin/timehook
24+
25+
With custom values:
26+
27+
./bin/timehook --delay 11 --url https://your-url.com body --body '{"bar" : "bar"}'
28+
29+
30+
For further info:
31+
32+
./bin/timehook --help

0 commit comments

Comments
 (0)