forked from janek/mostr
docs(readme): beta hints
This commit is contained in:
parent
d5e6bd2578
commit
cc1e9d4d69
1 changed files with 11 additions and 0 deletions
11
README.md
11
README.md
|
@ -2,6 +2,12 @@
|
||||||
|
|
||||||
An immutable nested collaborative task manager, powered by nostr!
|
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
|
## Quickstart
|
||||||
|
|
||||||
First, start a nostr relay, such as
|
First, start a nostr relay, such as
|
||||||
|
@ -24,6 +30,11 @@ Install latest build:
|
||||||
|
|
||||||
cargo install --path .
|
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:
|
Creating a test task externally:
|
||||||
`nostril --envelope --content "test task" --kind 1621 | websocat ws://localhost:4736`
|
`nostril --envelope --content "test task" --kind 1621 | websocat ws://localhost:4736`
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue