update readme

README.md

@@ -1,3 +1,22 @@
+## ⚠ Warning
+
+This piece of software was developed to solve a specific problem that I have.
+As a result I'm not sure it'd be useful for you, specifically because:
+- Hardcoded to my instances at mossnet.lan & sealight.xyz
+- Does not handle matrix bot creation
+- Hardcoded to post specifically to the only channel the bot has access to
+- Uses *only* environment variables for config (direnv handles this for me automatically, you may wish to create .envrc file)
+
+The devshell will warn you if you don't have the environment variables set
+
+The environment variables I use are:
+- SHAARLI_TOKEN
+- MATRIX_PASSWORD
+- WALLABAG_CLIENT_ID
+- WALLABAG_CLIENT_SECRET
+- WALLABAG_USERNAME
+- WALLABAG_PASSWORD
+
 ## Description 
 
 A collection of babashka scripts to remind me of things, by posting to my matrix channel
@@ -8,14 +27,25 @@ it (aspires to) check:
 - kitaab
 - the weather?
 
-## Expectations
+## Status
 
 ##### shaarli
+Does:
 - Connect to Shaarli 
+- Pick a random bookmark with the music tag that contains bandcamp in the url
+- post to matrix
+
+Maybe:
 - Check incoming & downloaded?
 - read 🔥'd responses and do something with that? 
 
 ##### wallabag
+Does:
+- connect to wallabag
+- pick a random archived article
+- post annotations, tags, title, url & wallabag url to matrix
+
+Maybe:
 - connect to wallabag
 - pick a random article
 - post