Merge pull request #25 from react-R/update-readme

update readme to add discussion of inputs

Author: timelyportfolio

README.Rmd

@@ -17,9 +17,9 @@ knitr::opts_chunk$set(
 
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/reactR)](https://cran.r-project.org/package=reactR)
 [![Travis-CI Build Status](https://travis-ci.org/react-R/reactR.svg?branch=master)](https://travis-ci.org/react-R/reactR)
+[![Slack Status](https://reactr-slackin.herokuapp.com/badge.svg)](https://reactr-slackin.herokuapp.com/)
 
-
-`reactR` provides a set of convenience functions for using [`React`](https://facebook.github.io/react) in `R` with `htmlwidget` constructor templates and local JavaScript dependencies.  The `React` ecosystem is rich with components that can enhance `R` web and Shiny apps.  `scaffoldReactWidget()` helps build `htmlwidgets` to integrate these `React` components as `R` `htmlwidgets`.  The local dependency functions are modeled after the `html_dependency_*` functions from RStudio's [`rmarkdown`](https://github.com/rstudio/rmarkdown) package.
+`reactR` provides a set of convenience functions for using [`React`](https://facebook.github.io/react) in `R` with `htmlwidget` constructor templates and local JavaScript dependencies.  The `React` ecosystem is rich with components that can enhance `R` web and Shiny apps.  `scaffoldReactWidget()` helps build `htmlwidgets` to integrate these `React` components as `R` `htmlwidgets`.  `scaffoldReactShinyInput()` does the same for `Shiny` inputs.  The local dependency functions are modeled after the `html_dependency_*` functions from RStudio's [`rmarkdown`](https://github.com/rstudio/rmarkdown) package.
 
 ## Installation
 
@@ -34,12 +34,14 @@ devtools::install_github("react-R/reactR")
 
 To wrap a `React` component as an `htmlwidget`, please see the tutorial [htmlwidgets with reactR](https://react-r.github.io/reactR/articles/intro_htmlwidgets.html).  Also, there are a variety of examples in the [react-R Github organization](https://github.com/react-R).
 
-## Shiny?
+## Shiny Outputs and Inputs
 
-Currently, `htmlwidgets` built with `reactR` work well in Shiny as outputs.  In the next version we hope to have a mechanism for input in Shiny contexts.
+`htmlwidgets` built with `reactR` work well in Shiny as outputs.  In version `0.4.0` Alan Dipert has added the ability to easily create React-based official `Shiny` inputs with helpers and scaffolds.  Please see the [tutorial](https://react-r.github.io/reactR/articles/intro_inputs.html) for more details.
 
 ## Examples
 
+Below are examples of using `reactR` directly.
+
 ```R
 library(reactR)
 library(htmltools)

README.md

@@ -6,16 +6,19 @@
 [![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/reactR)](https://cran.r-project.org/package=reactR)
 [![Travis-CI Build
 Status](https://travis-ci.org/react-R/reactR.svg?branch=master)](https://travis-ci.org/react-R/reactR)
-[![Slack Status](https://reactr-slackin.herokuapp.com/badge.svg)](https://reactr-slackin.herokuapp.com/)
+[![Slack
+Status](https://reactr-slackin.herokuapp.com/badge.svg)](https://reactr-slackin.herokuapp.com/)
 
 `reactR` provides a set of convenience functions for using
 [`React`](https://facebook.github.io/react) in `R` with `htmlwidget`
 constructor templates and local JavaScript dependencies. The `React`
 ecosystem is rich with components that can enhance `R` web and Shiny
 apps. `scaffoldReactWidget()` helps build `htmlwidgets` to integrate
-these `React` components as `R` `htmlwidgets`. The local dependency
-functions are modeled after the `html_dependency_*` functions from
-RStudio’s [`rmarkdown`](https://github.com/rstudio/rmarkdown) package.
+these `React` components as `R` `htmlwidgets`.
+`scaffoldReactShinyInput()` does the same for `Shiny` inputs. The local
+dependency functions are modeled after the `html_dependency_*` functions
+from RStudio’s [`rmarkdown`](https://github.com/rstudio/rmarkdown)
+package.
 
 ## Installation
 
@@ -35,14 +38,19 @@ reactR](https://react-r.github.io/reactR/articles/intro_htmlwidgets.html).
 Also, there are a variety of examples in the [react-R Github
 organization](https://github.com/react-R).
 
-## Shiny?
+## Shiny Outputs and Inputs
 
-Currently, `htmlwidgets` built with `reactR` work well in Shiny as
-outputs. In the next version we hope to have a mechanism for input in
-Shiny contexts.
+`htmlwidgets` built with `reactR` work well in Shiny as outputs. In
+version `0.4.0` Alan Dipert has added the ability to easily create
+React-based official `Shiny` inputs with helpers and scaffolds. Please
+see the
+[tutorial](https://react-r.github.io/reactR/articles/intro_inputs.html)
+for more details.
 
 ## Examples
 
+Below are examples of using `reactR` directly.
+
 ``` r
 library(reactR)
 library(htmltools)
@@ -93,7 +101,3 @@ We welcome contributors and would love your participation. Please note
 that this project is released with a [Contributor Code of
 Conduct](CONDUCT.md). By participating in this project you agree to
 abide by the terms.
-
-## Community
-
-We operate a [Slack](https://slack.com) workspace you are [more than welcome to join](http://reactr-slackin.herokuapp.com/).