Add user-friendly description in LP root

1 year ago · ca3c2911a3
parent ca322ff7cc
commit ca3c2911a3
2 changed files with 32 additions and 1 deletions
--- a/.gitignore
+++ b/.gitignore
@ -8,7 +8,8 @@ output/qr-codes
 output/icons

 # Served listings
-listings/lp-output
+listings/lp-output/*
+!listings/lp-output/index.html

 # Server-side cache
 cache
--- a/listings/lp-output/index.html
+++ b/listings/lp-output/index.html
@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>Listing provider by sessioncommunities.online</title>
+    </head>
+    <body>
+        <h1>Community Listing Provider API</h1>
+        <p>
+            Hi there!
+        </p>
+        <p>
+            This domain isn't meant to be accessed via a browser,
+            but to provide lists of Communities to <a href="https://getsession.org/" target="_blank">Session Messenger</a>, 
+            and looks something <a href="./listings" target="_blank">like this</a>.
+        </p>
+        <p>
+            If that doesn't phase you, click these links to read more about what this service does:
+        </p>
+        <p>
+            <a href="https://codeberg.org/gravel/session-listing-providers" target="_blank">
+                Session Listing Provider README
+            </a>
+        </p>
+        <p>
+            <a href="https://codeberg.org/gravel/session-listing-providers/src/branch/main/PROTOCOL.md" target="_blank">
+                Session Listing Provider Protocol Specification
+            </a>
+        </p>
+    </body>
+</html>