Add a README

.Rbuildignore

@@ -1,2 +1,4 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+README.rmd
+README.md

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: manipulateWidget
 Type: Package
-Title: Add More Interactivity to htmlWidgets
+Title: Add Even More Interactivity to interactive charts
 Version: 0.4.0
 Date: 2016-12-09
 Authors@R: c(
@@ -9,7 +9,7 @@ Authors@R: c(
     )
 Description: Like package 'manipulate' does for static graphics, this package
     helps to easily to add controls like slider, picker, checkboxes, etc. to an
-    interactive plot created with htmlWidget. This way one can use controls to
+    interactive chart created with htmlWidget. This way one can use controls to
     modify the input data or the parameters of a widget.
 Imports:
     shiny,

R/zzz.R

@@ -33,7 +33,7 @@
 #'
 #' The interface also contains a button "Done". When the user clicks on it, the
 #' last chart is returned. It can be stored in a variable, be modified by the
-#' user, saved as a html file with \code{[htmlwidgets]{saveWidget}} from package
+#' user, saved as a html file with \code{\link[htmlwidgets]{saveWidget}} from package
 #' \code{htmlwidgets} or converted to a static image file with package
 #' \code{webshot}.
 #'

README.Rmd

@@ -0,0 +1,37 @@
+---
+title: "Add more interactivity to interactive charts"
+output: github_document
+---
+
+```{r setup, include=FALSE}
+knitr::opts_chunk$set(echo = TRUE)
+library(manipulateWidget)
+library(webshot)
+```
+
+This R package is largely inspired by the `manipulate` package from
+Rstudio. It can be used to easily create graphical interface that lets the
+user modify the data or the parameters of an interactive chart. It also
+provides the `combineWidgets` function to easily combine multiple
+interactive charts in a single view. Of course both functions can be used 
+together.
+
+Here is an example:
+
+![An example of what one can do with manipulateWidgets](img/fancy-example.gif)
+
+## Installation
+
+The package can be installed from Github with package `devtools`:
+
+```{r eval=FALSE}
+devtools::install_github("rte-antares-rpackage/manipulateWidget")
+```
+
+To install the latest development version:
+
+```{r eval=FALSE}
+devtools::install_github("rte-antares-rpackage/manipulateWidget", ref="develop")
+```
+
+

README.md

@@ -0,0 +1,23 @@
+Add more interactivity to interactive charts
+================
+
+This R package is largely inspired by the `manipulate` package from Rstudio. It can be used to easily create graphical interface that lets the user modify the data or the parameters of an interactive chart. It also provides the `combineWidgets` function to easily combine multiple interactive charts in a single view. Of course both functions can be used together.
+
+Here is an example:
+
+![An example of what one can do with manipulateWidgets](img/fancy-example.gif)
+
+Installation
+------------
+
+The package can be installed from Github with package `devtools`:
+
+``` r
+devtools::install_github("rte-antares-rpackage/manipulateWidget")
+```
+
+To install the latest development version:
+
+``` r
+devtools::install_github("rte-antares-rpackage/manipulateWidget", ref="develop")
+```