From 9e2956f727017baac3a85a1b4a9683b002d2be8e Mon Sep 17 00:00:00 2001 From: Vincent Arel-Bundock Date: Mon, 26 Aug 2024 09:39:00 -0400 Subject: [PATCH] readme --- README.md | 6 ++++-- README.qmd | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5f7fe474..1db2aba1 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,12 @@ ecosystem. Why release a new one? As [the maintainer of package which was: - *Simple*: Streamlined, consistent, and uncluttered user interface, - with few functions to learn. + with only a few functions to learn. - *Flexible*: Expressive frameworks to customize tables in HTML and LaTeX formats.[1] - *Zero-dependency*: Avoid importing any other `R` package.[2] +- *Documented*: The website and documentation include 100s of examples + and tutorials. - *Concise*: Draw beautiful tables without typing a lot of code. - *Safe*: User inputs are checked thoroughly, and informative errors are returned early. @@ -131,7 +133,7 @@ tt(x, ## Tutorial -The `tinytable` 0.3.0.34 tutorial will take you much further. It is +The `tinytable` 0.4.0.1 tutorial will take you much further. It is available in two formats: - [Tutorial diff --git a/README.qmd b/README.qmd index f26c0bca..9476a71a 100644 --- a/README.qmd +++ b/README.qmd @@ -28,9 +28,10 @@ dep_gt <- tools::package_dependencies(c("gt"), recursive=TRUE, db=db)[[1]] |> le There are already many excellent table-drawing packages in the `R` ecosystem. Why release a new one? As [the maintainer of `modelsummary`](https://modelsummary.com), I needed a table-drawing package which was: -* *Simple*: Streamlined, consistent, and uncluttered user interface, with few functions to learn. +* *Simple*: Streamlined, consistent, and uncluttered user interface, with only a few functions to learn. * *Flexible*: Expressive frameworks to customize tables in HTML and LaTeX formats.^[Other formats like Markdown and Typst are also available, but less flexible.] * *Zero-dependency*: Avoid importing any other `R` package.^[Some extra packages can be imported to access specific functionality, such as integration with Quarto, inserting `ggplot2` objects as inline plots, and saving tables to PNG images or PDF documents.] +* *Documented*: The website and documentation include 100s of examples and tutorials. * *Concise*: Draw beautiful tables without typing a lot of code. * *Safe*: User inputs are checked thoroughly, and informative errors are returned early. * *Maintainable*: A small code base which does not rely on too many complex regular expressions.