From 939098048977c38b99d0b7efc793d31f3b8dd680 Mon Sep 17 00:00:00 2001 From: Chris Beck Date: Thu, 18 Dec 2025 15:48:25 -0700 Subject: [PATCH] add badges to many readme's etc. --- Cargo.toml | 10 +++++----- README.md | 10 +++++++--- prometheus-http-client/README.md | 7 +++++++ signal-cli-jsonrpc-client/README.md | 7 +++++++ signal-gateway-assistant/README.md | 7 +++++++ signal-gateway-assistant/claude/Cargo.toml | 7 +++++++ signal-gateway-assistant/claude/README.md | 9 ++++++++- 7 files changed, 48 insertions(+), 9 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 23e05c0..92e63fd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -35,11 +35,11 @@ assigning_clones = "allow" result_large_err = "allow" [workspace.dependencies] -prometheus-http-client = { path = "prometheus-http-client", default-features = false } -signal-cli-jsonrpc-client = { path = "signal-cli-jsonrpc-client" } -signal-gateway = { path = "signal-gateway", default-features = false } -signal-gateway-assistant = { path = "signal-gateway-assistant" } -signal-gateway-assistant-claude = { path = "signal-gateway-assistant/claude" } +prometheus-http-client = { path = "prometheus-http-client", version = "0.1.0", default-features = false } +signal-cli-jsonrpc-client = { path = "signal-cli-jsonrpc-client", version = "0.1.0" } +signal-gateway = { path = "signal-gateway", version = "0.1.0", default-features = false } +signal-gateway-assistant = { path = "signal-gateway-assistant", version = "0.1.0" } +signal-gateway-assistant-claude = { path = "signal-gateway-assistant/claude", version = "0.1.0" } async-trait = "0.1" chrono = { version = "0.4", default-features = false, features = ["clock", "serde", "std"] } diff --git a/README.md b/README.md index 4a61435..a3711b9 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,14 @@ An extensible monitoring tool, sending alerts via Signal messenger, and responding to requests for information (status, metrics values, plots) or other commands from administrators. +[![Crates.io](https://img.shields.io/crates/v/signal-gateway?style=flat-square)](https://crates.io/crates/signal-gateway) +[![Crates.io](https://img.shields.io/crates/d/signal-gateway?style=flat-square)](https://crates.io/crates/signal-gateway) [![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE-APACHE) [![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT) [![Build Status](https://img.shields.io/github/actions/workflow/status/cbeck88/signal-gateway/ci.yml?branch=master&style=flat-square)](https://github.com/cbeck88/signal-gateway/actions/workflows/ci.yml?query=branch%3Amaster) +[API Docs](https://docs.rs/signal-gateway/latest/signal_gateway/) + ## Overview `signal-gateway` receives alerts and log messages from various sources and forwards them to [Signal @@ -137,11 +141,11 @@ The log handler controls (not exhaustive): * When a log message can lead to an alert (by configuring one or more "routes") * Overall limits on alerting (applies to all routes) -See docs for `LogHandlerConfig` for more specifics. +See docs for [`LogHandlerConfig`](https://docs.rs/signal-gateway/latest/signal_gateway/log_handler/struct.LogHandlerConfig.html) for more specifics. High level: -* A `Route` consists of an `alert_level`, a `LogFilter`, and a series of `Limit`'s. +* A [`Route`](https://docs.rs/signal-gateway/latest/signal_gateway/log_handler/struct.Route.html) consists of an `alert_level`, a [`LogFilter`](https://docs.rs/signal-gateway/latest/signal_gateway/log_handler/struct.LogFilter.html), and a series of [`Limit`](https://docs.rs/signal-gateway/latest/signal_gateway/log_handler/struct.Limit.html)'s. If a message is at the alert level or higher, and it passes the filter, then we test each `Limit` in the route. * A `LogFilter` is a test against the fields of the log message. It is stateless. @@ -190,7 +194,7 @@ limits = [ ] ``` -For a complete list of `LogFilter` keys, see docs for `struct LogFilter`. +For a complete list of `LogFilter` keys, see docs for [`LogFilter`](https://docs.rs/signal-gateway/latest/signal_gateway/log_handler/struct.LogFilter.html). ### Claude diff --git a/prometheus-http-client/README.md b/prometheus-http-client/README.md index 98bbcfb..6637d52 100644 --- a/prometheus-http-client/README.md +++ b/prometheus-http-client/README.md @@ -1,5 +1,12 @@ # prometheus-http-client +[![Crates.io](https://img.shields.io/crates/v/prometheus-http-client?style=flat-square)](https://crates.io/crates/prometheus-http-client) +[![Crates.io](https://img.shields.io/crates/d/prometheus-http-client?style=flat-square)](https://crates.io/crates/prometheus-http-client) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE-APACHE) +[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT) + +[API Docs](https://docs.rs/prometheus-http-client/latest/prometheus_http_client/) + Makes requests to the prometheus query API. With `plot` feature, also provides a way to plot responses from prometheus. diff --git a/signal-cli-jsonrpc-client/README.md b/signal-cli-jsonrpc-client/README.md index f1bc9d9..a4bc217 100644 --- a/signal-cli-jsonrpc-client/README.md +++ b/signal-cli-jsonrpc-client/README.md @@ -1,5 +1,12 @@ # signal-cli-jsonrpc-client +[![Crates.io](https://img.shields.io/crates/v/signal-cli-jsonrpc-client?style=flat-square)](https://crates.io/crates/signal-cli-jsonrpc-client) +[![Crates.io](https://img.shields.io/crates/d/signal-cli-jsonrpc-client?style=flat-square)](https://crates.io/crates/signal-cli-jsonrpc-client) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE-APACHE) +[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT) + +[API Docs](https://docs.rs/signal-cli-jsonrpc-client/latest/signal_cli_jsonrpc_client/) + A Rust JSON-RPC client for [signal-cli](https://github.com/AsamK/signal-cli) daemon. ## Origin diff --git a/signal-gateway-assistant/README.md b/signal-gateway-assistant/README.md index 1c0b1e3..9902525 100644 --- a/signal-gateway-assistant/README.md +++ b/signal-gateway-assistant/README.md @@ -1,5 +1,12 @@ # signal-gateway-assistant +[![Crates.io](https://img.shields.io/crates/v/signal-gateway-assistant?style=flat-square)](https://crates.io/crates/signal-gateway-assistant) +[![Crates.io](https://img.shields.io/crates/d/signal-gateway-assistant?style=flat-square)](https://crates.io/crates/signal-gateway-assistant) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE-APACHE) +[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT) + +[API Docs](https://docs.rs/signal-gateway-assistant/latest/signal_gateway_assistant/) + Trait used to represent conversational assistant in `signal-gateway`. You can implement this trait yourself in order to customize `signal-gateway`. diff --git a/signal-gateway-assistant/claude/Cargo.toml b/signal-gateway-assistant/claude/Cargo.toml index 61f7ba0..89d0147 100644 --- a/signal-gateway-assistant/claude/Cargo.toml +++ b/signal-gateway-assistant/claude/Cargo.toml @@ -1,7 +1,14 @@ [package] name = "signal-gateway-assistant-claude" version = "0.1.0" +description = "Claude AI implementation of signal-gateway-assistant" +keywords = ["signal", "assistant", "ai", "claude", "anthropic"] +categories = ["asynchronous"] +authors.workspace = true +repository.workspace = true +license.workspace = true edition.workspace = true +include.workspace = true [lints] workspace = true diff --git a/signal-gateway-assistant/claude/README.md b/signal-gateway-assistant/claude/README.md index c7c7609..c2711ca 100644 --- a/signal-gateway-assistant/claude/README.md +++ b/signal-gateway-assistant/claude/README.md @@ -1,3 +1,10 @@ # signal-gateway-assistant-claude -A stock implementation of the `signal-gateway-assitant` trait, using anthropic's claude API. +[![Crates.io](https://img.shields.io/crates/v/signal-gateway-assistant-claude?style=flat-square)](https://crates.io/crates/signal-gateway-assistant-claude) +[![Crates.io](https://img.shields.io/crates/d/signal-gateway-assistant-claude?style=flat-square)](https://crates.io/crates/signal-gateway-assistant-claude) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE-APACHE) +[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT) + +[API Docs](https://docs.rs/signal-gateway-assistant-claude/latest/signal_gateway_assistant_claude/) + +A stock implementation of the `signal-gateway-assistant` trait, using Anthropic's Claude API.