Add basic readme

dtonon · Dec 17, 2023 · 592e884 · 592e884
1 parent 5cfc6e5
commit 592e884
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Stacker Beep
+
+Use this little command line tool to be informed about new content of Stacker.news, filering by author, topic, domains and territory.
+
+## Usage examples
+
+```
+sn-alert -authors=sn,k00b,kr,ekzyis,hn -topics=nostr,adoption,onboarding,wallet,hack -domains=github,lopp
+```
+
+```
+stacker-beep -topics=channel,fee,node -territory=bitcoin
+```
+
+![](screen.png)
+
+Run `stacker-beep -help` for more options.
diff --git a/screen.png b/screen.png