From 017eec8f9388167bc77354fb3e38e270c5f066d5 Mon Sep 17 00:00:00 2001 From: aphandersen Date: Sat, 11 Apr 2026 18:50:41 +0000 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 294b213..712eb63 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # Mastodon-archive-tool -A small python script that will convert a Mastodon archive into a static HTML page where all old Mastodon posts can be viewed. See demo on https://arkiv.andersen.one. \ No newline at end of file +A small python script that will convert a Mastodon archive into a static HTML page where all old Mastodon posts can be viewed. See demo on https://arkiv.andersen.one. + +## Features + +The purpose of this script was to create an archive of my old Mastodon profile, because I moved my profile to a new instance. The archive will include all posts, but not the comments or reboosts that has been made. + +- An introduction with an avatar, name, Mastodon handle, introduction and number of posts, answers and quote posts. +- An information that the profile has been moved. +- All posts listed with newest first. +- A sidebar with search fields and filter buttons. +- Possible to filter only posts or answers, posts with pictures, links or tags, year or used tags. + +## How to use + +The python script must be in same folder as Mastodon archive, and the archive file must be named "Archive.zip". Run the scrupt in a Linux terminal with Python installed using the code 'python3 generate_archive.py'. + +This will generate the static HTML page as index.html. The avatar will be in the same folder as avatar.png og media files will be included in the subfolder "media". + +The language of the generated Mastodon archive is **danish**. + +## License + +The script is published under the GPL 3.0 license or later, which means you can use it and modify it for free. + +## Follow me + +Follow me on Mastodon on [@aphandersen@andersen.one](https://andersen.one/@aphandersen). \ No newline at end of file