mirror of
https://github.com/msfjarvis/healthchecks-rs.git
synced 2024-06-03 04:18:58 +05:30
monitor: flesh out Cargo.toml and README
Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
This commit is contained in:
parent
2cdbaeceeb
commit
ee8854c487
|
@ -3,6 +3,13 @@ name = "monitor"
|
|||
version = "0.1.0"
|
||||
authors = ["Harsh Shandilya <me@msfjarvis.dev>"]
|
||||
edition = "2018"
|
||||
description = "Report results of arbitrary commands to healthchecks.io"
|
||||
repository = "https://github.com/msfjarvis/healthchecks-rs"
|
||||
homepage = "https://github.com/msfjarvis/healthchecks-rs"
|
||||
license = "MIT/Apache-2.0"
|
||||
keywords = ["healthchecks"]
|
||||
readme = "README.md"
|
||||
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
|
@ -14,3 +21,6 @@ clap = { version = "2.33.1", default-features = false, features = ["suggestions"
|
|||
lto = "fat"
|
||||
codegen-units = 1
|
||||
panic = "abort"
|
||||
|
||||
[badges]
|
||||
maintenance = { status = "actively-developed" }
|
||||
|
|
24
monitor/README.md
Normal file
24
monitor/README.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# monitor
|
||||
|
||||
Simple binary that's designed to execute arbitrary tasks and notify a provided healthchecks.io check about their status.
|
||||
|
||||
## Usage
|
||||
|
||||
```plaintext
|
||||
monitor 0.1.0
|
||||
Harsh Shandilya <me@msfjarvis.dev>
|
||||
CLI tool that executes arbitrary commands and notifies healthchecks.io about their status
|
||||
|
||||
USAGE:
|
||||
monitor [FLAGS] [OPTIONS] --command <command>
|
||||
|
||||
FLAGS:
|
||||
-h, --help Prints help information
|
||||
-t, --timer Starts a timer before running the command
|
||||
-V, --version Prints version information
|
||||
|
||||
OPTIONS:
|
||||
-c, --command <command> Command to execute and monitor
|
||||
--token <token> Healthchecks.io UUID to ping after executing the task
|
||||
-u, --user_agent <user_agent> Custom User-Agent header to uniquely identify the caller in healthchecks.io logs
|
||||
```
|
Loading…
Reference in New Issue
Block a user