From 042f1920c90851d44a8a3dce38b8db10b454c615 Mon Sep 17 00:00:00 2001 From: David Vogel Date: Wed, 18 Dec 2024 20:32:14 +0100 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d13dce9..5d806ff 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ # go-typst -A library to generate documents via [typst]. +A library to generate documents and reports by utilizing the command line version of [typst]. + +Features include: + +- Encoder to convert go objects into typst objects which then can be injected into typst documents. +- Parsing of returned errors into go error objects. +- Uses stdio; No temporary files need to be created. +- Test coverage of most features. ## Installation +1. Use `go get github.com/Dadido3/go-typst` inside of your module to add this library to your project. +2. Install typst by following [the instructions in the typst repository]. + ## Runtime requirements +You need to have [typst] installed on any machine that you want to run your go project on. +You can install it by following [the instructions in the typst repository]. + ## Usage +ToDo + +[the instructions in the typst repository]: https://github.com/typst/typst?tab=readme-ov-file#installation [typst]: https://typst.app/