From 710549ca8dcdbe776cb4d0c08184947baa1b4b9b Mon Sep 17 00:00:00 2001 From: Minecon724 Date: Tue, 11 Mar 2025 13:21:23 +0100 Subject: [PATCH] Update README Signed-off-by: Minecon724 --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 646a2b7..fdec5a5 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,6 @@ blog-software(config, template, content) = blog website ``` For tips on how to create your own project (workdir), see [Project format](#Project format) below. - -## Important caveats -Generated site must be the root of a subdomain, like `https://example.com/`. \ -You can't put it in a directory, like `https://example.com/blog/` ## API There's no "API," but it's possible to integrate this into your Java project. @@ -22,7 +18,7 @@ See [Main.java](/Minecon724/blog-software-java/src/branch/master/src/main/java/e If you need a Maven dependency, [see here](/Minecon724/-/packages/maven/eu.m724-blog) ## Project format -There's an ["Example workdir"](/Minecon724/blog-software-java/src/branch/master/example_workdir) which you can take inspiration from. +[Here's an example blog](/Minecon724/example-blog) you can take inspiration from. Basically: - `assets/` - contains static assets @@ -41,7 +37,7 @@ Basically: - Custom properties, which can be anything as they are Objects ## Template format -https://pebbletemplates.io is used +[Pebble Templates](https://pebbletemplates.io) is used - `static/` - contains static assets - `article_template.html` - article template