Repos / s4g / fd930d7702
commit fd930d77026bec7b8ab6aebfeb850cd5c706b98c
Author: Nhân <hi@imnhan.com>
Date:   Tue Jul 18 23:54:36 2023 +0700

    readme: add feature checklist

diff --git a/README.md b/README.md
index 26696e8..1945f08 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,27 @@
+![2-men-building-a-website](website-builder.jpg)
+
 **Warning: work in progress**
 
 WebMaker2000 is an in-place static site generator, meaning processed files are
 stored right next to their sources. This simplifies composing (source dir
-layout _is_ finished website layout) and publishing (simply `rsync`/`git push`
-your whole dir).
+layout _is_ finished website layout; static assets no longer need to be moved
+around) and publishing (simply `rsync`/`git push` your whole dir). It aims to
+be beginner-friendly while encouraging users to fiddle with html/css. To that
+end, the core feature set is purposefully simple:
+
+- [x] Finds all `*.dj` files, generates `*.html` in the same place
+    + Per-page metadata allows using custom template
+- [x] Generates home page, which is just a predefined `index.dj` + custom
+  template. This means the user is free to swap in their own custom home page.
+- [x] Generates RSS/Atom feed
+
+Quality-of-life features are not neglected:
+
+- [x] Livereload with no browser plugin (works but currently polls which is
+  noisy, should probably upgrade to websockets)
+- [ ] Shows user error messages on the livereloaded web page
+- [ ] Just enough GUI so user doesn't have to touch a terminal
+- [ ] 1-click deploy to popular static hosting targets (git push, rsync, etc.)
 
 There's a sample site up at <https://nhanb.github.io/webmaker2000/about/> which
 also further explains why this project exists.
@@ -12,6 +30,8 @@
 only Markdown derivative that actually tries to be both unambiguous _and_
 useful.
 
+Currently works on Linux. The plan is to package for Windows & macOS too.
+
 Requirements: `go` (build), `node` (runtime).
 
 ```sh
diff --git a/website-builder.jpg b/website-builder.jpg
new file mode 100644
index 0000000..45828d0
Binary files /dev/null and b/website-builder.jpg differ