From bc2eb631c954ba68c284c80ba2f7cf7ffb6130ec Mon Sep 17 00:00:00 2001 From: Vishal <64505169+vishalxl@users.noreply.github.com> Date: Thu, 22 Dec 2022 20:49:57 +0530 Subject: [PATCH] Updated Home (markdown) --- Home.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 7a2a8a7..68a8626 100644 --- a/Home.md +++ b/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 ` +or +`./nostr_console_exe --prikey=` + +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. \ No newline at end of file