From 0ab15e7ab0b1e157e8b528e9d97a4ab0fe16cb74 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Reynir=20Bj=C3=B6rnsson?= <reynir@reynir.dk>
Date: Sat, 6 Jan 2024 13:38:59 +0100
Subject: [PATCH] Add README

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f1c0737
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Phanpy
+
+[Phanpy](https://github.com/cheeaun/phanpy) is a frontend for Mastodon.
+It is served as static files.
+The upstream git repository contains files that need to be built.
+Alternatively, releases are published as `.tar.gz` archives.
+I don't want to run `npm` to build phanpy but I still want to have the artifacts as a git repository so the content can be fed to [unipi](https://github.com/roburio/unipi/).
+Thus I have hacked together a script where I can import the tar release files into a git history.
+
+To import a new release download the `.tar.gz` file and rename it to `VERSION.tar.gz` where `VERSION` is the release version.
+Then run `./import-tars.perl VERSION.tar.gz`.
+This will add the files from the archive to a commit on the `production` branch with a tag `VERSION`.
+The commit will contain a SHA256 digest of the archive for sake of reproducibility.