From 2d4b82edd9a01914e9fe7b2e57fa8c0015898fcd Mon Sep 17 00:00:00 2001 From: Daniel Date: Thu, 17 Oct 2024 03:07:03 -0400 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fc0e9f0..48d2f4e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,37 @@ # Zona -Zona is a small tool for building a static blog website. It allows users to write pages and blog posts in Markdown and automatically build them into a static, JavaScript-free style blog. +Zona is a small tool for building a static blog website. It allows users to write pages and blog posts in Markdown and automatically build them into a static, lightweight blog. -> **Warning:** Porting existing functionality into Go is still WIP. While this warning is here, Zona is _not_ ready to use! +Zona is quite opinionated about the website structure, since I am mainly building it for my own use. However, this may change as the project develops. + +> **Warning:** Implementing bare minimum basic functionality in Go is still WIP. While this warning is here, Zona is _not_ ready to use! At all! ## Features - Simple CLI build interface. +- Build a lightweight website with zero JavaScript. - Write your pages in Markdown or HTML. - Automatic RSS/Atom feed generation. - HTML layout optimized for screen readers. -## Build +## Getting Started + +### Dependencies TBD. -## Dependencies +### Build TBD. -## Planned Features +## Roadmap -- Zona configuration file to define build options. -- Image optimization & dithering options. -- [Norg](https://github.com/nvim-neorg/neorg) support. +- [ ] Zona configuration file to define build options. +- [ ] Image optimization & dithering options. +- [ ] [Norg](https://github.com/nvim-neorg/neorg) support...? +- [ ] AUR package after first release ---- +## Inspirations -Zona is inspired by [Zoner](https://git.sr.ht/~ryantrawick/zoner), a tool for building [Zonelets](https://zonelets.net/) style blogs. Zona is not committed to Zonelets backwards compatibility and will likely evolve new features. +- [Zoner](https://git.sr.ht/~ryantrawick/zoner) +- Zonelets \ No newline at end of file