From c935dfe4279c3b57c5cb63ca3e69a63c25cb1d6b Mon Sep 17 00:00:00 2001 From: Dereck Mezquita Date: Mon, 29 Jul 2024 00:48:22 -0500 Subject: [PATCH] Better readme. --- README.Rmd | 9 ++++++++- README.md | 13 +++++++++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.Rmd b/README.Rmd index 58df8b0..b1f3a84 100644 --- a/README.Rmd +++ b/README.Rmd @@ -26,7 +26,14 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h status](https://travis-ci.org/dereckmezquita/kucoin.svg?branch=master)](https://travis-ci.org/dereckmezquita/kucoin) -The `interface` package provides a system for defining and implementing interfaces in R, with runtime type checking, bringing some of the benefits of statically-typed languages to R. +The `interface` package provides a system for defining and implementing interfaces in R, with runtime type checking, bringing some of the benefits of statically-typed languages to R with zero dependencies. + +`interface` provides: + +1. **Interfaces**: Define and implement interfaces with type checking. Interfaces can be extended and nested. +1. **Typed Functions**: Define functions with strict type constraints. +1. **Typed Frames**: Choose between a `data.frame` or `data.table` with column type constraints and row validation. +1. **Enums**: Define and use enumerated types for stricter type safety. ## Installation diff --git a/README.md b/README.md index 8041f85..f492263 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,16 @@ status](https://travis-ci.org/dereckmezquita/kucoin.svg?branch=master)](https:// The `interface` package provides a system for defining and implementing interfaces in R, with runtime type checking, bringing some of the -benefits of statically-typed languages to R. +benefits of statically-typed languages to R with zero dependencies. + +`interface` provides: + +1. **Interfaces**: Define and implement interfaces with type checking. + Interfaces can be extended and nested. +2. **Typed Functions**: Define functions with strict type constraints. +3. **Typed Frames**: Choose between a `data.frame` or `data.table` with + column type constraints and row validation. +4. **Enums**: Define and use enumerated types for stricter type safety. ## Installation @@ -121,7 +130,7 @@ print(john_student) #> scores: Science #> scores: 95 #> scores: 88 -#> scholarship: +#> scholarship: #> street: 123 Main St #> city: Small town #> postal_code: 12345