Revert "Update README.md, add Codeberg migration notice"

This reverts commit 0b9a5c8.

README.md

@@ -1,5 +1,141 @@
-# Podcast Archiver [![PyPI](https://img.shields.io/pypi/v/podcast-archiver.svg)](https://pypi.org/project/podcast-archiver/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/podcast-archiver.svg)](https://pypi.org/project/podcast-archiver/)
+# Podcast Archiver
 
+<!-- markdownlint-disable MD033 MD013 -->
+<div align="center">
 
-**This project migrated to [Codeberg](https://codeberg.org): <https://codeberg.org/janw/podcast-archiver>**
+![Podcast Archiver Logo](assets/icon.png)
 
+[![PyPI](https://img.shields.io/pypi/v/podcast-archiver.svg)](https://pypi.org/project/podcast-archiver/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/podcast-archiver.svg)](https://pypi.org/project/podcast-archiver/)
+
+[![Code Quality](https://app.codacy.com/project/badge/Grade/d0c31899a9964ccc82fa4080717d45a6)](https://app.codacy.com/gh/janw/podcast-archiver/dashboard)
+[![codecov](https://codecov.io/gh/janw/podcast-archiver/branch/main/graph/badge.svg?token=G8WI2ZILRG)](https://codecov.io/gh/janw/podcast-archiver)
+
+[![Linter: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
+[![Code style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![Dependency management: poetry](https://img.shields.io/badge/deps-poetry-blueviolet.svg)](https://poetry.eustace.io/docs/)
+
+</div>
+
+Archive all episodes from your favorite podcasts.
+
+The archiver takes the feed URLs of your favorite podcasts and downloads all available episodes for you. Even those files "hidden" in a paged feed will be tapped, so you'll have an entire backup of the series. The archiver also supports updating an existing archive, so that it lends itself to be set up as a cronjob.
+
+## Outline
+
+In my experience, very few full-fledged podcast clients are able to access a paged feed (following IETF RFC5005), so only the last few episodes of a podcast will be available to download. When you discover a podcast that has been around for quite a while, you'll have a hard time to follow the "gentle listener's duty" and listen to the whole archive. The script in this repository is supposed to help you acquiring every last episode of your new listening pleasure.
+
+Before downloading any episode the function first fetches all available pages of the feed and prepares a list. That way, you will never miss any episode.
+
+## Setup
+
+### Python package
+
+`podcast-archiver` is Python 3.9+ compatible.
+
+```bash
+# Latest tagged/published version on PyPI:
+pip install podcast-archiver
+
+# Latest development version from main branch:
+pip install git+https://github.com/janw/podcast-archiver.git
+```
+
+### Docker image
+
+Alternatively `podcast-archiver` is available as a docker image as well:
+
+```bash
+# Latest tagged/published version, same as on PyPI:
+docker run --rm ghcr.io/janw/podcast-archiver:latest
+
+# Latest development version from main branch:
+docker run --rm ghcr.io/janw/podcast-archiver:edge
+```
+
+## Usage
+
+Run `podcast-archiver --help` for details on how to use it.
+
+### Full-fledged example
+
+```bash
+podcast-archiver -d ~/Music/Podcasts \
+    --subdirs \
+    --date-prefix \
+    --progress \
+    --verbose \
+    -f http://logbuch-netzpolitik.de/feed/m4a \
+    -f http://raumzeit-podcast.de/feed/m4a/ \
+    -f https://feeds.lagedernation.org/feeds/ldn-mp3.xml
+```
+
+### Process the feed list from a file
+
+If you have a larger list of podcasts and/or want to update the archive on a cronjob basis, the `-f` argument can be outsourced into a text file. The text file may contain one feed URL per line, looking like this:
+
+```bash
+podcast-archiver -d ~/Music/Podcasts -s -u -f feedlist.txt
+```
+
+where `feedlist.txt` contains the URLs as if entered into the command line:
+
+```text
+    http://logbuch-netzpolitik.de/feed/m4a
+    http://raumzeit-podcast.de/feed/m4a/
+    https://feeds.lagedernation.org/feeds/ldn-mp3.xml
+```
+
+This way, you can easily add and remove feeds to the list and let the archiver fetch the newest episodes for example by adding it to your crontab.
+
+### Using a config file
+
+Command line arguments can be replaced with entries in a YAML configuration file. An example config can be generated with
+
+```bash
+podcast-archiver --config-generate path/to/config.yaml
+```
+
+After modifying the settings to your liking, `podcast-archiver` can be run with
+
+```bash
+podcast-archiver --config path/to/config.yaml
+```
+
+Alternatively (for example, if you're running `podcast-archiver` in Docker), you may point it to the config file using the `PODCAST_ARCHIVER_CONFIG=path/to/config.yaml` environment variable.
+
+### Using environment variables
+
+`podcast-archiver` uses [Pydantic](https://docs.pydantic.dev/latest/usage/settings/#parsing-environment-variable-values) to parse and validate its configuration. You can also prefix all configuration options (as used in the config file) with `PODCAST_ARCHIVER_` and export the results as environment variables to change the behavior, like so:
+
+```bash
+export PODCAST_ARCHIVER_FEEDS='[
+    "http://raumzeit-podcast.de/feed/m4a/",
+    "https://feeds.lagedernation.org/feeds/ldn-mp3.xml"
+]'  # Must be a string of a JSON array
+export PODCAST_ARCHIVER_SLUGIFY_PATHS=true
+export PODCAST_ARCHIVER_VERBOSE=2
+```
+
+## Excursion: Unicode Normalization in Slugify
+
+The `--slugify` option removes all ambiguous characters from folders and filenames used in the archiving process. The removal includes unicode normalization according to [Compatibility Decomposition](http://unicode.org/reports/tr15/tr15-18.html#Decomposition). What? Yeah, me too. I figured this is best seen in an example, so here's a fictitious episode name, and how it would be translated to an target filename using the Archiver:
+
+```text
+SPR001_Umlaute sind ausschließlich in schönen Sprachen/Dialekten zu finden.mp3
+```
+
+will be turned into
+
+```text
+SPR001_Umlaute-sind-ausschlielich-in-schonen-SprachenDialekten-zu-finden.mp3
+```
+
+Note that "decorated" characters like `ö` are replaced with their basic counterparts (`o`), while somewhat ligatur-ish ones like `ß` (amongst most unessential punctuation) are removed entirely.
+
+## Todo
+
+* Add ability to define a preferred format on feeds that contain links for multiple audio codecs.
+* Add ability to define a range of episodes or time to download only episode from that point on or from there to the beginning or or or …
+* Add ability to choose a prefix episodes with the episode number (rarely necessary, since most podcasts feature some kind of episode numbering in the filename)
+* Add unittests