summary refs log tree commit diff
path: root/README.org
diff options
context:
space:
mode:
authorvenomade <venomade@venomade.com>2024-12-16 22:04:47 +0000
committervenomade <venomade@venomade.com>2024-12-16 22:04:47 +0000
commit12080f04fb2121c1076a23cedc7e17e360da648d (patch)
tree775793154fa19064a27e5c2103a76481e7f025d5 /README.org
parent21874c403c7b04da9cf408a42dfd7aab6ae3177d (diff)
Improvements to README, DataDir, DEBUG and comments HEAD master
Expand README
Remove Hardcoding of Data Directory
Add DEBUG const
Remove unnecesary comments
Diffstat (limited to 'README.org')
-rw-r--r--README.org14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.org b/README.org
index 7a8faf3..2cff1a0 100644
--- a/README.org
+++ b/README.org
@@ -2,3 +2,17 @@
 
 * Lifesigns
 A CLI for status applications that shows live followed streamers
+
+~'secrets' File not found, Check the README~:
+- Create the file ~"~~/.local/share/lifesigns/secrets"~
+- Populate it with 2 lines being your registered Twitch app's ClientID and ClientSecret
+  #+begin_src
+    clientid
+    clientsecret
+  #+end_src
+
+** TODO
+- Finish this README
+- User should only interact with a config in .config/lifesigns
+- Add -h/--help for otf configuration
+- Replace Error panics with sending up the chain to Main