documented how to run this (#4)

zippy1981 · Jan 6, 2024 · b4aa693 · b4aa693
1 parent 408b2ff
commit b4aa693
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,3 +7,16 @@ Some mastadon utilities I wrote
 | Workflow | Status |
 |---|:---|
 | Lint README.md | ![Lint README.md status badge](https://github.com/USERNAME/REPOSITORY/actions/workflows/readme.yml/badge.svg) |
+
+## configuration
+
+To run the script you will need a `.secrets.toml` fie with the API Key like so:
+
+```toml
+dynaconf_merge = true # very important to not overwrite settings.toml
+
+[MASTODON_API]
+KEY="YOUR_API_KEY"
+```
+
+Also set the server in `settings.toml`.