From cc1e9d4d69cc53f64020e5464531a7c866280eaa Mon Sep 17 00:00:00 2001 From: xeruf <27jf@pm.me> Date: Sun, 10 Nov 2024 20:29:09 +0100 Subject: [PATCH] docs(readme): beta hints --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 06aea18..24881dd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ An immutable nested collaborative task manager, powered by nostr! +> Mostr is beta software. +> Do not entrust it exclusively with your data unless you know what you are doing! + +> Intermediate versions might not properly persist all changes. +> A failed relay connection currently looses all intermediate changes. + ## Quickstart First, start a nostr relay, such as @@ -24,6 +30,11 @@ Install latest build: cargo install --path . +This one-liner can help you stay on the latest version +(optionally add a `cd` to your mostr-directory in front): + + git pull && cargo install --path . && mostr + Creating a test task externally: `nostril --envelope --content "test task" --kind 1621 | websocat ws://localhost:4736`