updated readme

README.md

@@ -1,18 +1,23 @@
 # Zona
 
-Zona is a tool for building a static website, optimized for lightweight blogs
+[Zona](https://sr.ht/~ficd/zona/) is a tool for building a static website,
-following minimalist design principles.
+optimized for lightweight blogs following minimalist design principles. The
+project is hosted on [sourcehut](https://sr.ht/~ficd/zona/) and mirrored on
+[GitHub](https://github.com/ficcdaf/zona). You are welcome to open an issue on
+GitHub or send a message to the
+[mailing list](https://lists.sr.ht/~ficd/zona-devel).
 
 <!-- prettier-ignore-start -->
-> [!NOTE] 
+
-> Zona is currently in development. The `main` branch of this repository
+> [!NOTE]
-> does not yet contain the software. The `dev-stable` branch contains the code
+> Zona is currently in development. The `main` branch of this repository does
-> used to generate [ficd.ca](https://ficd.ca) -- although the program is
+> not yet contain the software. The `dev-stable` branch contains the code used
-> undocumented and missing features, so please proceed at your own risk. The
+> to generate [ficd.ca](https://ficd.ca) -- although the program is undocumented
-> `dev` branch contains the latest development updates and is not guaranteed to
+> and missing features, so please proceed at your own risk. The `dev` branch
-> be functional (or even compile) at any given commit. Kindly note that the
+> contains the latest development updates and is not guaranteed to be functional
-> commit history will be cleaned up before the program is merged into the `main`
+> (or even compile) at any given commit. Kindly note that the commit history
-> branch.
+> will be cleaned up before the program is merged into the `main` branch.
+
 <!-- prettier-ignore-end -->
 
 ## Design Goals
@@ -26,31 +31,30 @@ the smallest file sizes possible. These characteristics make Zona well-suited
 for both beginners and power users that wish to host a website on a service like
 Neocities or GitHub Pages.
 
-## Feature Progress
+## Features Implemented
 
-- [x] Write pages purely in Markdown.
+- Write pages purely in Markdown.
-- [x] Single-command build process.
+- Single-command build process.
-- [x] Lightweight output.
+- Lightweight output.
-- [x] Sensible default template and stylesheet.
+- Sensible default template and stylesheet.
-- [x] Configuration file.
+- Configuration file.
-- [x] Internal links preserved.
+- Internal links preserved.
-- [x] Custom image element parsing & formatting.
+- Custom image element parsing & formatting.
-- [x] Site header and footer defined in Markdown.
+- Site header and footer defined in Markdown.
-- [x] YAML frontmatter support.
+- YAML frontmatter support.
-- [ ] Automatically treat contents of `posts/` directory as blog posts.
+
-- [ ] Automatically generated `Archive`, `Recent Posts`, and `Image Gallery` [ ]
+## Planned Features
-      elements.
+
-- [ ] Support for custom stylesheets, favicons, and page templates.
+- Automatically treat contents of `posts/` directory as blog posts.
-- [ ] Image optimization and dithering.
+- Automatically generated `Archive`, `Recent Posts`, and `Image Gallery`
-- [ ] Custom markdown tags that expand to user-defined templates.
+  elements.
-- [ ] Live preview server.
+- Support for custom stylesheets, favicons, and page templates.
-- [ ] Robust tests.
+- Image optimization and dithering.
+- Custom markdown tags that expand to user-defined templates.
+- Live preview server.
+- Robust tests.
 
 ## Inspirations
 
 - [Zoner](https://git.sr.ht/~ryantrawick/zoner)
 - [Zonelets](https://zonelets.net/)
-
-> Note: I am aware of `Zola`, and the similar name is entirely a coincidence. I
-> have never used it, nor read its documentation, thus it is not listed as an
-> inspiration.