Skip to content

Commit

Permalink
Update Client README file
Browse files Browse the repository at this point in the history
  • Loading branch information
lontivero committed Feb 4, 2024
1 parent 2796a20 commit 017d453
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions Nostra.Client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ Nostra.Client is heavily "inspired" on [nostr-commander-rs](https://github.com/8

# Build from source

## Using Nix

The easiest way to have both the relay and the client is by building the nix flake as follow:

```bash
$ nix build github:lontivero/nostra?dir=Contrib
```

# Config File

Expand Down Expand Up @@ -62,18 +69,35 @@ you can copy and paste this config file to get going real fast.
# Example Usage

```
$ Nostra.Client --create-user --name "Juan" \
$ ncli --create-user --name "Juan" \
--display-name "The greatest Juan" --about "Just a random guy for the sake of this documentation" \
--picture "https://i.imgur.com/lKMdIps.png" \
--nip05 [email protected] \
--add-relay "wss://relay.primal.net" "wss://nostr.bitcoiner.social"
$ Nostra.Client --publish "Wow, that was easy!"
$ Nostra.Client --subscribe-author npub1xtscya34g58tk0z605fvr788k263gsu6cy9x0mhnm87echrgufzsevkk5s
$ Nostra.Client --subscribe-channel 25e5c82273a271cb1a840d0060391a0bf4965cafeb029d5ab55350b418953fbb
$ ncli --create "Wow, that was easy!" --publish
$ ncli --subscribe-author npub1xtscya34g58tk0z605fvr788k263gsu6cy9x0mhnm87echrgufzsevkk5s
$ ncli --subscribe-channel 25e5c82273a271cb1a840d0060391a0bf4965cafeb029d5ab55350b418953fbb
```

# Usage

```
$ ncli \
--create "hello #nostr look at my repo https://github.com/lontivero/Nostra nostr:nevent1qqswdshtyvpxkfelmzrmk9uk35vm0762mmt5pde600ljstswzd275hcpp4mhxue69uhkummn9ekx7mqpr4mhxue69uhkummnw3ez6ur4vgh8wetvd3hhyer9wghxuet5qgsfuv8fgq3cek0ta0rr9qtkm4x3pxqjz22y9u4xcwrj0lrxlfl2jzsrqsqqqqqpx9tsca"
--secret nsec1tc43eek43unn8ntcx8y3e2lkdxk66zjvq0t8zqaqvhk0jqd7w3as3wwca7"
```

```json
{
"id": "3143fc2616eeadb0e23c149c398b2b79cb54a62bc0cc2007c4c9537e78b0beb9",
"content": "hello #nostr look at my repo https://github.com/lontivero/Nostra nostr:nevent1qqswdshtyvpxkfelmzrmk9uk35vm0762mmt5pde600ljstswzd275hcpp4mhxue69uhkummn9ekx7mqpr4mhxue69uhkummnw3ez6ur4vgh8wetvd3hhyer9wghxuet5qgsfuv8fgq3cek0ta0rr9qtkm4x3pxqjz22y9u4xcwrj0lrxlfl2jzsrqsqqqqqpx9tsca",
"pubkey": "c7d398301c213940d017166a58132dfc6e7cc12f5e3196458e18c47396dedfc6",
"created_at": 1706984702,
"kind": 1,
"tags": [
[ "t", "nostr" ],
[ "r", "https://github.com/lontivero/Nostra" ],
[ "e", "e6c2eb23026b273fd887bb17968d19b7fb4aded740b73a7bff282e0e1355ea5f", "wss://nos.lol", "wss://nostr-pub.wellorder.net" ]
],
"sig": "723d2656bbf1da5798ff17341123c448678f452221a0ccdd7f013672a3d300ab43223062bb7283cff22d87c4d225b4b73744d96852948b864547c26cf9574ec9"
}
```

0 comments on commit 017d453

Please sign in to comment.