Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentarelbundock committed Jan 24, 2024
1 parent 31ebf84 commit c93b1fc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 16 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@
<p align="center">
<img src="man/figures/gallery/tinytable_gallery.gif" height = "250" class = "center">
<br> <!-- badges: start -->
[![](https://www.r-pkg.org/badges/version/tinytable?color=green.png)](https://cran.r-project.org/package=tinytable)
[![](https://img.shields.io/badge/license-GPLv3-blue.png)](https://github.com/vincentarelbundock/tinytable/blob/main/LICENSE.md)
<!--
[![](http://cranlogs.r-pkg.org/badges/grand-total/tinytable?color=green)](https://cran.r-project.org/package=tinytable)
[![](http://cranlogs.r-pkg.org/badges/last-month/tinytable?color=green)](https://cran.r-project.org/package=tinytable)
[![](http://cranlogs.r-pkg.org/badges/last-week/tinytable?color=green)](https://cran.r-project.org/package=tinytable)
--> <!-- badges: end -->
<a href = "https://github.com/vincentarelbundock/tinytable/blob/main/LICENSE.md" target = "_blank"><img src="https://img.shields.io/badge/license-GPLv3-blue"></a>
<a href = "https://vincentarelbundock.github.io/tinytable/" target = "_blank"><img src="https://img.shields.io/static/v1?label=Website&message=Visit&color=blue"></a>
<!-- badges: end -->
</p>

## What?
Expand Down Expand Up @@ -52,7 +48,7 @@ three pillars:
modify the actual text in each cell to style it. Keeping data and
style separate allows `tinytable` to create human-readable files
which are easy to edit, debug, and extend. It also enables
developers to keep a tidy code base, with minimal use of messy
developers to keep a simpler code base, with minimal use of messy
regular expressions.

2. *Flexibility.* Users’ needs are extremely varied, and a
Expand Down
11 changes: 3 additions & 8 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@
<img src="man/figures/gallery/tinytable_gallery.gif" height = "250" class = "center">
<br>
<!-- badges: start -->
[![](https://www.r-pkg.org/badges/version/tinytable?color=green)](https://cran.r-project.org/package=tinytable)
[![](https://img.shields.io/badge/license-GPLv3-blue)](https://github.com/vincentarelbundock/tinytable/blob/main/LICENSE.md)
<!--
[![](http://cranlogs.r-pkg.org/badges/grand-total/tinytable?color=green)](https://cran.r-project.org/package=tinytable)
[![](http://cranlogs.r-pkg.org/badges/last-month/tinytable?color=green)](https://cran.r-project.org/package=tinytable)
[![](http://cranlogs.r-pkg.org/badges/last-week/tinytable?color=green)](https://cran.r-project.org/package=tinytable)
-->
<a href = "https://github.com/vincentarelbundock/tinytable/blob/main/LICENSE.md" target = "_blank"><img src="https://img.shields.io/badge/license-GPLv3-blue"></a>
<a href = "https://vincentarelbundock.github.io/tinytable/" target = "_blank"><img src="https://img.shields.io/static/v1?label=Website&message=Visit&color=blue"></a>
<!-- badges: end -->
</p>

Expand Down Expand Up @@ -44,7 +39,7 @@ There are already many excellent table-drawing packages in the `R` ecosystem. Wh

To achieve these goals, the design philosophy of `tinytable` rests on three pillars:

(1) _Data is separate from style._ The code that this package creates keeps the content of a table separate from the style sheet that applies to its cells. This is in contrast to other `R` packages that modify the actual text in each cell to style it. Keeping data and style separate allows `tidytable` to create human-readable files which are easy to edit, debug, and extend. It also enables developers to keep a tidy code base, with minimal use of messy regular expressions.
(1) _Data is separate from style._ The code that this package creates keeps the content of a table separate from the style sheet that applies to its cells. This is in contrast to other `R` packages that modify the actual text in each cell to style it. Keeping data and style separate allows `tinytable` to create human-readable files which are easy to edit, debug, and extend. It also enables developers to keep a simpler code base, with minimal use of messy regular expressions.

(2) _Flexibility._ Users' needs are extremely varied, and a table-drawing package must be flexible enough to accomodate different ideas. To achieve this, `tinytable` builds on battle-tested and versatile frameworks like `Bootstrap` for HTML and `tabularray` for LaTeX.

Expand Down

0 comments on commit c93b1fc

Please sign in to comment.