all: update README

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>

README.md

@@ -1,7 +1,16 @@
 # healthchecks-rs
 
-A Rust library for working with [healthchecks.io](https://healthchecks.io). This repository contains the [library](healthchecks) as well as a binary project called [monitor](monitor) that uses healthchecks-rs for signalling about execution of arbitrary tasks provided to it.
+Rust crates for working with [healthchecks.io]. The repository contains these crates:
+
+- [healthchecks]: A library that provides a type-safe way to access to the [healthchecks.io] pinging and management APIs. Currently covers all methods, please file an issue if a new one is added.
+- [healthchecks-monitor]: A CLI tool that uses [healthchecks] to interface with the pinging API.
+- [hcctl]: Another CLI tool, which utilises a subset of the management API to let users list current checks and get their last 10 pings.
 
 ## Licensing
 
 Dual licensed under Apache 2.0 or MIT at your option.
+
+[healthchecks.io]: https://healthchecks.io
+[healthchecks]: healthchecks
+[healthchecks-monitor]: monitor
+[hcctl]: hcctl

healthchecks/README.md

@@ -22,9 +22,7 @@ A simple Rust library that allows pinging [healthchecks.io](https://healthchecks
 - [x] Get a list of check's status changes
 - [x] Get a list of existing integrations
 
-## Usage
-
-Usage is super simple!
+## Usage (pinging API)
 
 ```rust
 use healthchecks::config::get_config;
@@ -36,7 +34,7 @@ fn main() {
 }
 ```
 
-Or if you want to set a custom user agent for filtering purposes (default is `healthcheck-rs/$library_version`)
+If you want to set a custom user agent for filtering purposes (default is `healthcheck-rs/$library_version`)
 
 ```rust
 use healthchecks::config::get_config;

monitor/README.md

@@ -4,19 +4,19 @@ Simple binary that's designed to execute arbitrary tasks and notify a provided h
 
 ## Usage
 
-### Execute an arbitrary task
+### Execute a shell command
 
 ```shell
 HEALTHCHECKS_CHECK_ID=<check_id> healthchecks-monitor -X "sleep 10"
 ```
 
-### Start off a timer server-side
+### Track execution time at healthchecks.io
 
 ```shell
 HEALTHCHECKS_CHECK_ID=<check_id> healthchecks-monitor -tX "sleep 10"
 ```
 
-### Use a custom user agent
+### Use a custom user agent for reporting
 
 ```shell
 HEALTHCHECKS_USERAGENT=crontab HEALTHCHECKS_CHECK_ID=<check_id> healthchecks-monitor -tX "sleep 10"