Skip to content

Commit 840ab82

Browse files
committed
Add tweak screenshots to README and Getting Started guide
Embeds four screenshots (committed under images/) from the upstream tweak PR Apollo-Reborn/Apollo-Reborn#229: - IMG_4296: Custom API > Notification Backend settings (README tweak section + guide step 6) - IMG_4293: registration 'hello, is this thing on?' confirmation (guide step 6) - IMG_4294 / IMG_4295: example PM and post-reply push notifications (guide step 7)
1 parent 52b9b49 commit 840ab82

6 files changed

Lines changed: 28 additions & 0 deletions

File tree

GETTING_STARTED.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,11 @@ On your iPhone, in Apollo (with the tweak installed):
331331
3. Tap **Test Connection**. This hits `GET /v1/health` on your backend — a success here means the
332332
app can reach it.
333333

334+
<p align="center">
335+
<img src="images/IMG_4296.jpg" width="300"
336+
alt="Apollo Settings → Custom API → Notification Backend, with the Backend URL and Registration Token fields and a Test Connection button">
337+
</p>
338+
334339
While you're here, double-check the **main Custom API screen** has your **Reddit API Key**,
335340
**Redirect URI**, and **User Agent** filled in for *this* bundle ID (you needed these to get Reddit
336341
browsing working at all). The notification backend reuses them.
@@ -341,6 +346,14 @@ Finally, **turn notifications on**:
341346
- Inside Apollo, enable inbox notifications for your account (and add any subreddit/user **watchers**
342347
you want).
343348

349+
Once registration succeeds, the backend sends a **"hello, is this thing on?"** confirmation — a quick
350+
sign the whole chain is wired up:
351+
352+
<p align="center">
353+
<img src="images/IMG_4293.PNG" width="300"
354+
alt="Apollo's in-app notifications settings showing the backend's 'hello, is this thing on?' confirmation after a successful registration">
355+
</p>
356+
344357
---
345358

346359
## 7. Verify end-to-end (a real push)
@@ -385,6 +398,16 @@ can swap in for `post_reply`:
385398
comment_reply private_message username_mention subreddit_watcher trending_post
386399
```
387400

401+
Here's what a delivered push looks like on the lock screen — a private message and a post reply:
402+
403+
<p align="center">
404+
<img src="images/IMG_4294.PNG" width="270"
405+
alt="Private message push notification on the iOS lock screen">
406+
&nbsp;
407+
<img src="images/IMG_4295.PNG" width="270"
408+
alt="Post reply push notification on the iOS lock screen">
409+
</p>
410+
388411
### 7c. The first-message "warmup" gotcha
389412

390413
The **first real inbox message after registration won't notify you.** On its first poll the worker

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ In the tweak (Apollo on-device): **Settings > Custom API > Notification Backend*
104104

105105
Tap **Test Connection** to verify the tweak can reach `GET /v1/health`.
106106

107+
<p align="center">
108+
<img src="images/IMG_4296.jpg" width="300"
109+
alt="Apollo Settings > Custom API > Notification Backend, showing the Backend URL and Registration Token fields and the Test Connection button">
110+
</p>
111+
107112
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.
108113

109114
Installed-app Reddit credentials are accepted — just leave the **Reddit API Secret** field blank in the tweak.

images/IMG_4293.PNG

663 KB
Loading

images/IMG_4294.PNG

9.38 MB
Loading

images/IMG_4295.PNG

9.43 MB
Loading

images/IMG_4296.jpg

294 KB
Loading

0 commit comments

Comments
 (0)