From 3b67e7731d6a60ebc375d49ce89da325b26c9454 Mon Sep 17 00:00:00 2001
From: Niko Abeler <niko@rerere.org>
Date: Wed, 3 Aug 2022 17:56:13 +0200
Subject: [PATCH] directory structure

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2e6ff5e..208468d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
 # Owl Blogs
 
-A simple web server for blogs generated from Markdown files
\ No newline at end of file
+A simple web server for blogs generated from Markdown files
+
+
+## Repository
+
+A repository holds all data for a web server. It contains multiple users.
+
+## User
+
+A user has a collection of posts. 
+Each directory in the `/users/` directory of a repository is considered a user.
+
+### User Directory structure
+
+```
+<user-name>/
+  \- public/
+       \- <post-name>
+            \- index.md 
+                -- This will be rendered as the blog post.
+                -- Must be present for the blog post to be valid.
+                -- All other folders will be ignored
+            \- media/
+                -- Contains all media files used in the blog post.
+                -- All files in this folder will be publicly available
+  \- meta/
+       \- base.html
+            -- The template used to render all sites
+       \- VERSION
+            -- Contains the version string.
+            -- Used to determine compatibility in the future
+  \- config.yml
+        -- Contains settings global to the user.
+        -- For example: page title and style options
\ No newline at end of file