Update README

eoda-dev · Sep 13, 2024 · da6cad8 · da6cad8
1 parent 9a7d959
commit da6cad8
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 3 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -9,3 +9,4 @@ _NAMESPACE
 ^docs$
 ^pkgdown$
 ^\.github$
+images/
diff --git a/README.Rmd b/README.Rmd
@@ -22,18 +22,54 @@ knitr::opts_chunk$set(
 The goal of rtabulator is to make it a breeze creating beautiful and reactive tables using
 [Tabulator JS](https://tabulator.info/)
 
+## Features
+
+* Filters
+* Grouping
+* Multiple column formatters (images, html, progress bar, ...)
+* Multiple themes
+* Multi column headers
+* Spreadsheet mode supporting multiple sheets
+* Cell editing supporting validation
+* Downloads (json, csv, xlsx)
+* Interactivity
+
 ## Installation
 
+Once on CRAN you can install rtabulator with:
+
+``` r
+install.packages("rtabulator")
+```
+
 You can install the development version of rtabulator like so:
 
 ``` r
 remotes::install_github("eodaGmbH/rtabulator")
 ```
 
-## Example
+## Basic Usage
 
-```r
+``` r
 library(rtabulator)
 
 tabulator(mtcars)
+
+# Set theme
+tabulator(iris, theme = "midnight")
+
+# Format columns
+tabulator(airquality) |>
+  set_formatter_progress(
+    column = "Temp",
+    legend = TRUE,
+    legend_align = "left"
+  )
+
+# Spreadsheet mode
+tabulator(data = list(), spreadsheet = TRUE)
 ```
+
+## Documentation
+
+[rtabulator docs](https://eodagmbh.github.io/rtabulator/)
diff --git a/README.md b/README.md
@@ -4,23 +4,61 @@
 # rtabulator
 
 <!-- badges: start -->
+
+[![R-CMD-check](https://github.com/eodaGmbH/rtabulator/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/eodaGmbH/rtabulator/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
 The goal of rtabulator is to make it a breeze creating beautiful and
 reactive tables using [Tabulator JS](https://tabulator.info/)
 
+## Features
+
+- Filters
+- Grouping
+- Multiple column formatters (images, html, progress bar, …)
+- Multiple themes
+- Multi column headers
+- Spreadsheet mode supporting multiple sheets
+- Cell editing supporting validation
+- Downloads (json, csv, xlsx)
+- Interactivity
+
 ## Installation
 
+Once on CRAN you can install rtabulator with:
+
+``` r
+install.packages("rtabulator")
+```
+
 You can install the development version of rtabulator like so:
 
 ``` r
 remotes::install_github("eodaGmbH/rtabulator")
 ```
 
-## Example
+## Basic Usage
 
 ``` r
 library(rtabulator)
 
 tabulator(mtcars)
+
+# Set theme
+tabulator(iris, theme = "midnight")
+
+# Format columns
+tabulator(airquality) |>
+  set_formatter_progress(
+    column = "Temp",
+    legend = TRUE,
+    legend_align = "left"
+  )
+
+# Spreadsheet mode
+tabulator(data = list(), spreadsheet = TRUE)
 ```
+
+## Documentation
+
+[rtabulator docs](https://eodagmbh.github.io/rtabulator/)
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,3 +9,4 @@ _NAMESPACE @@
     ^docs$
     ^pkgdown$
     ^\.github$
+    images/