From 725dda72046d88d696f0070f6e3c902e93793120 Mon Sep 17 00:00:00 2001
From: Erb3 <49862976+Erb3@users.noreply.github.com>
Date: Mon, 17 Jun 2024 21:50:57 +0200
Subject: [PATCH] ci: add shuttle deployment action

---
 .github/workflows/shuttle.yml | 15 +++++++++++++++
 README.md                     | 14 ++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 .github/workflows/shuttle.yml

diff --git a/.github/workflows/shuttle.yml b/.github/workflows/shuttle.yml
new file mode 100644
index 0000000..4631a69
--- /dev/null
+++ b/.github/workflows/shuttle.yml
@@ -0,0 +1,15 @@
+name: Shuttle Deploy
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: shuttle-hq/deploy-action@main
+        with:
+          deploy-key: ${{ secrets.SHUTTLE_API_KEY }}
diff --git a/README.md b/README.md
index aba70ab..6c363dc 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # Sveio
 
 A geography game inspired by [Posio](https://github.com/abrenaut/posio), written in 🔥🚀Rust.
+View the public instance at [sveio.shuttleapp.rs](https://sveio.shuttleapp.rs)!
 
 ## Deployment
 
@@ -8,6 +9,8 @@ A geography game inspired by [Posio](https://github.com/abrenaut/posio), written
 > Sveio does not impose any rate limit itself.
 > You have to do this yourself, with something like nginx.
 
+### Docker
+
 Sveio is available as a docker image. If you use `docker run` you can run the following to start it:
 
 ```bash
@@ -26,6 +29,17 @@ services:
     restart: unless-stopped
 ```
 
+### Shuttle
+
+[Shuttle.rs](https://shuttle.rs) is supported for the demo server.
+To enable shuttle support use the `shuttle` feature.
+
+Deploy with Shuttle:
+
+```shell
+cargo shuttle deploy
+```
+
 ## Configuration
 
 The server uses the following environmental variables, and it also parses the .env file if present: