From 46934e502f242e47d890c5b1efc156b047946600 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Sun, 13 Jul 2025 21:25:20 -0400 Subject: [PATCH] update readme --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1fbb3e4..dcccab2 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,6 @@ engine. However, if you're looking for something stable, complete, and fully configurable, zona may not be for you. If you want a minimal Markdown blog and are comfortable with modifying `jinja2` templates and CSS, then you're in luck. -**Note:** This project is in early development, there are no versioned releases -yet, and breaking changes are likely. Versioned releases will be made and zona -will be published to PyPI once it's stable. zona was previously implemented in -Go; I decided to rewrite the project in Python. If you're interested in seeing -the previous codebase (which is feature incomplete), visit the -[zona-go](https://git.ficd.sh/ficd/zona-go) repository. - For an example of a website built with zona, please see [ficd.sh](https://ficd.sh). For a list of known problems, see [Known Problems](#known-problems). @@ -74,11 +67,16 @@ For an example of a website built with zona, please see ## Installation -zona is not yet packaged on PyPI. You may use `uv` to install it from this -repository: +Zona can be installed as a Python package. Instructions for +[`uv`](https://docs.astral.sh/uv/) are provided. ```sh +# install latest release +uv tool install zona +# install bleeding edge from git uv tool install 'git+https://git.ficd.sh/ficd/zona' +# you can also run without installation +uvx zona build --help ``` ## Usage