From 03ce127d7ade0679610d04bd5a5c55bc0479e93f Mon Sep 17 00:00:00 2001 From: berrysweet Date: Wed, 5 Jul 2023 21:49:03 +0200 Subject: [PATCH] docs: update README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 03fdbc4..0dd782b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # livejrnl-rs -Render a jrnl.sh site as a static website. Written in Rust. \ No newline at end of file +An application to render [jrnl.sh](https://jrnl.sh) journals as a static website. Written in Rust and licensed under the [GPLv3 license](LICENSE). + +## Work In Progress + +This is a work in progress. As of right now, there is no meaningful output. + +My goal is to be able to run this command and have a website populated by my journal: + +`jrnl --format json | livejrnl-rs -o $HOME/Websites/livejrnl-rs/` + +## Remarks + +This is my first Rust application. The code here may not be the best practices. I welcome issues that bring it up, and would love a nudge in the right direction on how to fix them. :) -- libgit2 1.7.2