commit fafd714bba4068617e82230964cb75bb745e3014
parent 009af9ed5b873d8d5c702d5e013105d26e655d8b
Author: William Casarin <jb55@jb55.com>
Date: Thu, 14 Apr 2022 07:56:50 -0700
readme
Signed-off-by: William Casarin <jb55@jb55.com>
Diffstat:
| A | README.md | | | 41 | +++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 41 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+
+# nostril
+
+A cli util for creating nostr events
+
+## Examples
+
+Generate an event:
+
+ $ ./nostril --sec <key> "this is a message"
+ {
+ "id": "b5c18a4aa21231a77b09748a5e623d9c2f853aed09653934b80a10b66a7225fa",
+ "pubkey": "fd3fdb0d0d8d6f9a7667b53211de8ae3c5246b79bdaf64ebac849d5148b5615f",
+ "created_at": 1649948031,
+ "kind": 1,
+ "tags": [],
+ "content": "testing something again",
+ "sig": "5122b2fc0d9a1f1ca134e4ab6fc1c9e5795e2d558cf24e3c7d8c4a35f889130eebcbd604602092a89c8a48469e88753e08dabb472610ac628ec9db3aa6c24672"
+ }
+
+Wrap event to send to a relay:
+
+ $ ./nostril --envelope --sec <key> "hello"
+ [
+ "EVENT",
+ {
+ "id": "ed378d3fdda785c091e9311c6e6eeb075db349a163c5e38de95946f6013a8001",
+ "pubkey": "fd3fdb0d0d8d6f9a7667b53211de8ae3c5246b79bdaf64ebac849d5148b5615f",
+ "created_at": 1649948103,
+ "kind": 1,
+ "tags": [],
+ "content": "hello",
+ "sig": "9d9a49bbc66d4782030b24c71416965e790214d02a54ab132d960c2b02def0371c3d93e5a60a285c55e99721599d1332450731e2c6bb1114b96b591c6967f872"
+ }
+ ]
+
+Send to a relay:
+
+ $ ./nostril --envelope --sec <key> "this is a message" | websocat wss://nostr-pub.wellorder.net
+
+
