Merge pull request #7 from metabase/add-readme

Add a little README
metabase · Oct 25, 2023 · 3d2d242 · 3d2d242
2 parents e47fe5a + 463efc8
commit 3d2d242
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# backend-docs
+
+_The literary home for Metabase Clojurians_
+
+This repo has two parts: the `master` branch has a Github action to get the Metabase source code, generate an HTML file
+with Marginalia, and push it to this repo's `gh-pages` branch. It runs on a cron job, currently every eight hours.
+
+The `gh-pages` branch gets automatically deployed to
+[metabase.com/backend-docs](https://www.metabase.com/backend-docs/).
+