Merge pull request #3 from Apollo-Reborn/docs/getting-started-guide

Add beginner Getting Started guide

Author: nickclyde

GETTING_STARTED.md

@@ -2,10 +2,23 @@
 
 A self-hostable fork of [`christianselig/apollo-backend`](https://github.com/christianselig/apollo-backend), the archived Go service that powered push notifications, inbox checks, and subreddit/user watchers for the original [Apollo for Reddit](https://apolloapp.io/) iOS app.
 
-This fork is meant to be run together with **[JeffreyCA/Apollo-ImprovedCustomApi](https://github.com/JeffreyCA/Apollo-ImprovedCustomApi)** — the iOS tweak that lets sideloaded Apollo builds use the user's own Reddit OAuth credentials. The tweak's **Settings > Custom API > Notification Backend** URL field points at an instance of this fork; with that wired up, push notifications and watchers come back to life for sideloads that have a real APNs entitlement.
+<p align="center">
+  <img src="images/IMG_4294.jpg" width="270"
+       alt="Private message push notification from a self-hosted Apollo backend on the iOS lock screen">
+  &nbsp;
+  <img src="images/IMG_4295.jpg" width="270"
+       alt="Post reply push notification from a self-hosted Apollo backend on the iOS lock screen">
+</p>
+
+<p align="center"><em>Reddit push notifications, back on a sideloaded Apollo — delivered entirely by your own server.</em></p>
+
+This fork is meant to be run together with **[Apollo-Reborn/Apollo-Reborn](https://github.com/Apollo-Reborn/Apollo-Reborn)** — the iOS tweak that lets sideloaded Apollo builds use the user's own Reddit OAuth credentials. The tweak's **Settings > Custom API > Notification Backend** URL field points at an instance of this fork; with that wired up, push notifications and watchers come back to life for sideloads that have a real APNs entitlement.
 
 Single-tenant by design: one deployment serves one sideloaded Apollo build (one bundle ID, one Apple Developer team), and can be shared with a small group of friends running the same build.
 
+> [!TIP]
+> **New to self-hosting this?** Start with the **[step-by-step Getting Started guide](GETTING_STARTED.md)** — it walks you all the way from installing Docker and creating an APNs key to a test push landing on your phone (and optionally exposing the backend to the internet). This README is the technical reference; that guide is the on-ramp.
+
 ## Before you start
 
 Three hard prerequisites — none of these are negotiable, and skipping any of them produces failure modes that look like backend bugs but aren't:
@@ -37,7 +50,7 @@ The result: the backend boots end-to-end with only Postgres, Redis, an APNs auth
 Requires Docker + an APNs auth key (`.p8`) from a paid Apple Developer account.
 
 ```bash
-git clone https://github.com/<you>/apollo-backend
+git clone https://github.com/Apollo-Reborn/apollo-backend
 cd apollo-backend
 
 # 1. Drop your APNs key
@@ -101,6 +114,11 @@ In the tweak (Apollo on-device): **Settings > Custom API > Notification Backend*
 
 Tap **Test Connection** to verify the tweak can reach `GET /v1/health`.
 
+<p align="center">
+  <img src="images/IMG_4296.jpg" width="300"
+       alt="Apollo Settings > Custom API > Notification Backend, showing the Backend URL and Registration Token fields and the Test Connection button">
+</p>
+
 Make sure the **Reddit API Key**, **Redirect URI**, and **User Agent** in the tweak's main Custom API screen are filled in for the bundle ID you signed with — Reddit's API rules want a UA shaped like `ios:com.you.Leto:v1.0 (by /u/yourname)`. The tweak attempts to inject these into registration bodies; if injection fails, the backend falls back to the matching `REDDIT_*` env vars (see above). Either path works.
 
 Installed-app Reddit credentials are accepted — just leave the **Reddit API Secret** field blank in the tweak.

README.md

@@ -8,7 +8,7 @@ x-worker: &worker
   build:
     context: .
     dockerfile: Dockerfile
-  image: ${APOLLO_IMAGE:-ghcr.io/nickclyde/apollo-backend:latest}
+  image: ${APOLLO_IMAGE:-ghcr.io/apollo-reborn/apollo-backend:latest}
   <<: *app-env
   volumes: *app-volumes
   depends_on:
@@ -110,7 +110,7 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
-    image: ${APOLLO_IMAGE:-ghcr.io/nickclyde/apollo-backend:latest}
+    image: ${APOLLO_IMAGE:-ghcr.io/apollo-reborn/apollo-backend:latest}
     command: ["api"]
     <<: *app-env
     volumes: *app-volumes