Skip to content

Commit b157f9c

Browse files
committed
update README.md
1 parent 9d78171 commit b157f9c

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ For a practical runbook, see [Memory + Task Flow](./MEMORY_TASK_FLOW.md).
3636
# Install the plugin (automatically installs the bm CLI via uv)
3737
openclaw plugins install @basicmemory/openclaw-basic-memory
3838

39-
# Enable and assign to the memory slot
40-
openclaw plugins enable openclaw-basic-memory --slot memory
41-
4239
# Restart the gateway
4340
openclaw gateway restart
4441
```
@@ -575,28 +572,24 @@ openclaw-basic-memory/
575572

576573
## Telemetry
577574

578-
This plugin collects anonymous, minimal usage events to understand plugin adoption and tool usage patterns. This helps us prioritize features and improve the product.
575+
Basic Memory collects anonymous, minimal usage events to understand how the CLI-to-cloud conversion funnel performs. This helps us prioritize features and improve the product.
579576

580577
**What we collect:**
581-
- Plugin registration and startup events
582-
- First use of each tool per session (deduplicated — not every call)
583-
- Plugin version with each event
578+
- Cloud promo impressions (when the promo banner is shown)
579+
- Cloud login attempts and outcomes
580+
- Promo opt-out events
584581

585582
**What we do NOT collect:**
586-
- No file contents, note titles, search queries, or conversation text
583+
- No file contents, note titles, or knowledge base data
587584
- No personally identifiable information (PII)
588585
- No IP address tracking or fingerprinting
589-
- No per-command tracking beyond first-use-per-session
586+
- No per-command or per-tool-call tracking
590587

591-
Events are sent to our [Umami Cloud](https://umami.is) instance, an open-source, privacy-focused analytics platform. Events are fire-and-forget with a 3-second timeout — analytics never blocks or slows the plugin.
588+
Events are sent to our [Umami Cloud](https://umami.is) instance, an open-source, privacy-focused analytics platform. Events are fire-and-forget on a background thread — analytics never blocks or slows the CLI.
592589

593-
**Opt out** by setting either environment variable:
590+
**Opt out** by setting the environment variable:
594591

595592
```bash
596-
# Plugin-specific opt-out
597-
export OPENCLAW_BASIC_MEMORY_TELEMETRY=0
598-
599-
# Or use the shared Basic Memory opt-out (also disables BM CLI telemetry)
600593
export BASIC_MEMORY_NO_PROMOS=1
601594
```
602595

0 commit comments

Comments
 (0)