summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRaphael Kabo <raphaelkabo@hey.com>2024-02-28 22:39:49 +0000
committerRaphael Kabo <raphaelkabo@hey.com>2024-02-28 22:39:49 +0000
commitd2a3d0272ed7725d0bc848267d560c468235507b (patch)
tree2605d9b9be3e22abdefd89075b4a8a2187cb9a4a /README.md
parent35398241dea769bd7554eaca0a9045801c847340 (diff)
Add docs using MkDocs
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3e0b205..6dab599 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,10 @@
[![Build status](https://github.com/lowercasename/gathio/actions/workflows/deploy.yaml/badge.svg)](https://github.com/lowercasename/gathio/actions/workflows/deploy.yaml)
-Self-destructing, shareable, no-registration event pages.
+A simple, federated, privacy-first event hosting platform.
-You can use the publicly hosted version [here](https://gath.io).
+You can use the flagship publicly hosted version [here](https://gath.io).
-# Installation
+# Documentation
-See [the Wiki](https://github.com/lowercasename/gathio/wiki/install) for installation instructions.
+To learn more about how to use Gathio, or how to set up your own instance, vist our [documentation site](https://docs.gath.io). If the site isn't working, the source documentation files are in the [`docs/` directory](https://github.com/lowercasename/gathio/tree/main/docs).