From 686aba5541cee0977a2cdd799f8ab2b7f83920e4 Mon Sep 17 00:00:00 2001
From: hippoz <10706925-hippoz@users.noreply.gitlab.com>
Date: Thu, 28 Apr 2022 04:26:01 +0300
Subject: [PATCH] add hosting guide (dockerless hosting guide coming soon)

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2bc3722..c0f50db 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
-# waffle.chat
+# waffle
+
+Waffle is a simple, focused chat application and protocol meant to be self-hosted.
+
+# Hosting
+
+## Docker
+
+If you plan on self-hosting Waffle, it's recommended to use Docker and docker-compose like shown below. This isn't recommended if you plan on developing Waffle. The guide below assumes you have `git` installed on your system (on Debian/Ubuntu: `sudo apt install git`):
+ 1. [Install Docker using the official guide](https://docs.docker.com/engine/install/)
+ 2. [Install docker-compose using the official guide](https://docs.docker.com/compose/install/)
+ 3. Clone the Waffle repository: `git clone https://git.hippoz.xyz/hippoz/waffle`
+ 4. Enter the repository's directory: `cd waffle`
+ 5. **Optionally,** you can open up `docker-compose.yml` in your text editor to change options like the port. The default port is `5002`.
+ 6. Start the stack: `docker-compose up -d`
+ 7. All done! 🎉 Waffle is now running on port `5002`.