From e2c32365934a703fe00bf024618f507712c356ad Mon Sep 17 00:00:00 2001 From: dmackdev Date: Tue, 24 Oct 2023 20:06:54 +0100 Subject: [PATCH] Update readme. --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7faaae5..a5e9dd4 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,26 @@ [![Build Status](https://github.com/dmackdev/pubsubman/workflows/CI/badge.svg)](https://github.com/dmackdev/pubsubman/actions?workflow=CI) -A GUI client for GCP Pub/Sub, built in Rust with `egui`. +A GUI client for GCP Pub/Sub, built in Rust with [egui](https://github.com/emilk/egui).

Messages View Screenshot

+## Features + +- [x] Pull or stream messages from topics on automatically created, dedicated subscriptions. +- [x] Interactive JSON visualisation for message data. +- [x] Copy message data JSON structures to the clipboard. +- [x] Filter received messages by ID or JSON contents. +- [x] Publish new messages, and republish previously received messages. +- [x] Persistence of received messages. +- [x] Option to delete created subscriptions when quitting the app. + ## Usage +`pubsubman` internally uses the [google-cloud-pubsub](https://crates.io/crates/google-cloud-pubsub) crate. As such, the `GOOGLE_APPLICATION_CREDENTIALS` and `GOOGLE_APPLICATION_CREDENTIALS_JSON` environment variables are respected for authenticating against a GCP Project. + If wishing to use a locally running GCP Pub/Sub emulator, ensure your `PUBSUB_EMULATOR_HOST` environment variable is set, e.g: ```