From 4fcb3891a2d954b2c7525310d3e60ee4f3fdcbef Mon Sep 17 00:00:00 2001
From: Philipp Heckel
Date: Sun, 5 Dec 2021 07:31:05 -0500
Subject: [PATCH] More docs; omg why is this taking so long
---
docs/privacy.md | 2 +-
server/index.gohtml | 90 +++++++++----------
server/static/img/android-video-overview.mp4 | Bin 0 -> 1289875 bytes
server/static/img/badge-fdroid.png | Bin 0 -> 4524 bytes
server/static/img/screenshot-docs.png | Bin 0 -> 137474 bytes
5 files changed, 46 insertions(+), 46 deletions(-)
create mode 100644 server/static/img/android-video-overview.mp4
create mode 100644 server/static/img/badge-fdroid.png
create mode 100644 server/static/img/screenshot-docs.png
diff --git a/docs/privacy.md b/docs/privacy.md
index c13f35c1..b5f0aa51 100644
--- a/docs/privacy.md
+++ b/docs/privacy.md
@@ -1,6 +1,6 @@
# Privacy policy
-I love free software and I'm doing this because it's fun and to give back. I have no bad intentions and I will
+I love free software, and I'm doing this because it's fun. I have no bad intentions, and I will
never monetize or sell your information. This service will always stay free and open.
Neither the server nor the app record any personal information, or share any of the messages and topics with
diff --git a/server/index.gohtml b/server/index.gohtml
index b1a75dab..8d2c0226 100644
--- a/server/index.gohtml
+++ b/server/index.gohtml
@@ -80,8 +80,9 @@
curl -d "Backup successful 😀" ntfy.sh/mytopic
+
+
+
+ Sending push notifications to your Android phone
+
+
Subscribe in this Web UI
@@ -118,59 +135,42 @@
-
Subscribe from your phone
+
Subscribe using the API
- You can use the Ntfy Android App
- to receive notifications directly on your phone. Just like the server, this app is also open source.
- Since I don't have an iPhone or a Mac, I didn't make an iOS app yet. I'd be awesome if someone else could help out.
+ There's a super simple API that you can use to integrate your own app. You can consume
+ a JSON stream,
+ an SSE/EventSource stream (useful for web apps),
+ as well as a plain text stream.
- To consume JSON instead, use the /json endpoint, which prints one message per line:
+ Here's an example for JSON. Note that the connection stays open, so you can retrieve messages as they come in:
- Or use the /raw endpoint if you need something super simple (empty lines are keepalive messages):
+
+
+
+
+
+
More, more, more!
+
+ ntfy has so many more features and you can learn about all of them in the documentation
+ (I tried my very best to make it the best docs ever 😉, not sure if I succeeded, hehe).
+
+
+
+
+
Forever free, forever 100% free software
+
+ I love free software, and I'm doing this because it's fun. I have no bad intentions, and I will
+ never monetize or sell your information. This service will always stay free and open. You can
+ read more in the FAQs and in the privacy policy.
-
- $ curl -s ntfy.sh/mytopic/raw
-
- This is a notification
- And another one with a smiley face 😀
-