Skip to content

Commit 240beb8

Browse files
committed
docs: add demo.gif placeholder and fix repo URLs in README
1 parent 6cded2d commit 240beb8

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> **Privacy-first performance diagnostics for Node.js — minimum Node 14.18 as a compiled package, Node 22.6 for source/dev mode**
44
5+
![Argus demo](https://raw.githubusercontent.com/sharon77242/Argus/master/docs/demo.gif)
6+
57
A lightweight agent that embeds directly into your application — silently tracking runtime behaviour, isolating bottlenecks, and mathematically sanitizing all context before exporting OpenTelemetry (OTLP) telemetry to your observability stack.
68

79
---
@@ -699,7 +701,7 @@ const suggestions = cbd.analyze(recentQueryEvents);
699701
> [!IMPORTANT]
700702
> **OTLP export requires a paid Self-Hosted Pro or Enterprise license.**
701703
> In free mode the agent emits events locally via `EventEmitter` only — `.withExporter()` has no effect without a valid `DIAGNOSTIC_LICENSE_KEY`.
702-
> To get notified when Self-Hosted Pro licenses go on sale: open [this GitHub issue](https://github.com/YOUR_ORG/YOUR_REPO/issues/YOUR_ISSUE) or email [sharon10vp614@gmail.com](mailto:sharon10vp614@gmail.com).
704+
> To get notified when Self-Hosted Pro licenses go on sale: open [this GitHub issue](https://github.com/sharon77242/Argus/issues) or email [sharon10vp614@gmail.com](mailto:sharon10vp614@gmail.com).
703705
704706
The Self-Hosted Pro tier exports standard OTLP JSON directly to your own collector — no data ever leaves your infrastructure. Any OTLP-compatible collector works. Below is the quickest local setup using Jaeger's all-in-one image.
705707

@@ -755,7 +757,7 @@ Local suggestions fire today with zero account required.
755757
A hosted dashboard with 30-day query history, AI-powered fix suggestions,
756758
and cross-service correlation is in development.
757759

758-
→ Subscribe via [this GitHub issue](https://github.com/YOUR_ORG/YOUR_REPO/issues/YOUR_ISSUE) or email [sharon10vp614@gmail.com](mailto:sharon10vp614@gmail.com) to be notified at launch.
760+
→ Subscribe via [this GitHub issue](https://github.com/sharon77242/Argus/issues) or email [sharon10vp614@gmail.com](mailto:sharon10vp614@gmail.com) to be notified at launch.
759761

760762
---
761763

0 commit comments

Comments
 (0)