highperfocused/nostr_console
1
0
Fork 0
mirror of https://github.com/vishalxl/nostr_console.git synced 2025-03-17 21:31:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

Vishal 2022-12-22 20:49:57 +05:30
parent a77cca6550
commit bc2eb631c9
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Home.md

@ -1 +1,15 @@
Welcome to the nostr_console wiki!
# Introduction to Nostr Console
The simplest way to start nostr console is
`./nostr_console_exe -k <private key in hex>`
or
`./nostr_console_exe --prikey=<private key in hex>`
Once it starts, the basic flow of the Nostr Console application is the following: Once you invoke the application with a --prikey option, it allows you to use this app as a Nostr client, where you can send events, message etc, as well as read them.
After you exit the app for the first time ( at end of its first invocation) the app will store all the events it has received in a file in pwd which by default is named "all_nostr_events.txt". The name does not imply that it has ALL nostr events, but only it has all the events that have been received by this client till now.
On next invocations, the app will read events from the file, and also fetch new events from the relays. And if it gets new events, it will show them as notifications.
The name of file is controlled by --file flag. Which will prove useful when you want to use the client with multiple accounts.