Add README.md

retrohub-org · Jul 27, 2023 · 86f5111 · 86f5111
1 parent 662bb36
commit 86f5111
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 1 deletion.
diff --git a/.github/workflows/runner.yml b/.github/workflows/runner.yml
@@ -59,7 +59,7 @@ jobs:
         run: |
           mkdir artifacts
           cd ./artifacts_windows
-          zip -9 -r eirteam-ffmpeg-${{ steps.vars.outputs.sha_short }}-windows.zip *
+          zip -9 -r eirteam-ffmpeg-${{ steps.vars.outputs.sha_short }}.zip *
           mv *.zip ../artifacts/
           cd ..
           set -xe

diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+![](img/cover.jpg)
+# EIRTeam.FFmpeg
+
+GDExtension Video Decoder library for [Godot Engine](https://godotengine.org) >4.1,
+using the [FFmpeg](https://ffmpeg.org) library.
+
+# Documentation
+
+The official documentation can be found [here](https://eirteam-docs.readthedocs.io/en/latest/documentation/ffmpeg/ffmpeg_getting_started.html).
+
+# Supporting development
+
+You can also support EIRTeam by donating on [Patreon] or purchasing [Project Heartbeat](https://store.steampowered.com/app/1216230/Project_Heartbeat/).
+
+<a href="https://www.patreon.com/EIRTeam" target="_blank">
+  <img alt="Patreon Link" src="img/patreon_support.png">
+</a>
+
+[Patreon]: https://www.patreon.com/EIRTeam
diff --git a/img/cover.jpg b/img/cover.jpg
diff --git a/img/patreon_support.png b/img/patreon_support.png