added AppImage download button

README.md

@@ -5,10 +5,11 @@
   </a>
   <p align="center">ssh man-in-the-middle (ssh-mitm) server for security audits supporting<br> <b>publickey authentication</b>, <b>session hijacking</b> and <b>file manipulation</b></p>
   <p align="center">
-   <a href='https://flathub.org/apps/at.ssh_mitm.server'><img height='56' alt='Download on Flathub' src='https://dl.flathub.org/assets/badges/flathub-badge-en.png'/></a>
-   <a href="https://snapcraft.io/ssh-mitm">
-     <img  height='56' alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" />
-   </a>
+   <a href="https://github.com/ssh-mitm/ssh-mitm/releases/latest/download/ssh-mitm-x86_64.AppImage"><img height='56' alt='Download as an AppImage' src='https://docs.appimage.org/_images/download-appimage-banner.svg'/></a>
+   &nbsp;&nbsp;&nbsp;
+   <a href="https://flathub.org/apps/at.ssh_mitm.server"><img height='56' alt='Download on Flathub' src='https://dl.flathub.org/assets/badges/flathub-badge-en.png'/></a>
+   &nbsp;&nbsp;&nbsp;
+   <a href="https://snapcraft.io/ssh-mitm"><img  height='56' alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" /></a>
    <br />
    <br />
    <a href="https://docs.ssh-mitm.at"><img src="https://read-the-docs-guidelines.readthedocs-hosted.com/_downloads/d9606423d87d78fcceae4ee2af883b12/logo-wordmark-dark.png" title="read the docs" width="256"></a>

doc/index.rst

@@ -28,6 +28,17 @@ The first step to using any software package is getting it properly installed.
 
 To install SSH-MITM, simply run one of those commands in your terminal of choice:
 
+:fas:`cog` AppImage
+-------------------
+
+If you use the ``AppImage``, you can install it as:
+
+.. code:: none
+
+    $ wget https://github.com/ssh-mitm/ssh-mitm/releases/latest/download/ssh-mitm-x86_64.AppImage
+    $ chmod +x ssh-mitm*.AppImage
+
+
 :fab:`linux` Flatpak
 --------------------
 
@@ -52,17 +63,6 @@ If you use ``snap``, you can install it with:
     $ sudo snap install ssh-mitm
 
 
-:fas:`cog` AppImage
--------------------
-
-If you use the ``AppImage``, you can install it as:
-
-.. code:: none
-
-    $ wget https://github.com/ssh-mitm/ssh-mitm/releases/latest/download/ssh-mitm-x86_64.AppImage
-    $ chmod +x ssh-mitm*.AppImage
-
-
 :fab:`python` pip
 ------------------
 

pyproject.toml

@@ -114,6 +114,16 @@ check = [
     "mypy sshmitm",
 ]
 
+[tool.hatch.envs.docs]
+detached = false
+
+[tool.hatch.envs.docs.scripts]
+build = [
+    "pip install -r doc/requirements.txt",
+    "sphinx-apidoc -T -e -M -d 1 -o doc/api sshmitm",
+    "sphinx-build doc build/html",
+]
+
 [tool.hatch.envs.appimage]
 detached = false