Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 66 lines (42 sloc) 3.445 kB
c41d4d3 @yihui enable Travis CI
yihui authored
1 # Shiny
2
3b324e9 @eiriksm Use svg version of build status. Only show master build status.
eiriksm authored
3 [![Build Status](https://travis-ci.org/rstudio/shiny.svg?branch=master)](https://travis-ci.org/rstudio/shiny)
bbd3643 @jcheng5 Bootstrap instructions
jcheng5 authored
4
334f6c8 @jjallaire sync readme to welcome
jjallaire authored
5 Shiny is a new package from RStudio that makes it incredibly easy to build interactive web applications with R.
41716d1 @jcheng5 Change startApp/runApp signature
jcheng5 authored
6
3999f4d @trestletech Updated external links to the Shiny Dev Center.
trestletech authored
7 For an introduction and examples, visit the [Shiny Dev Center](http://shiny.rstudio.com/).
96a7373 @jcheng5 Add linked example
jcheng5 authored
8
334f6c8 @jjallaire sync readme to welcome
jjallaire authored
9 ## Features
1f93610 @jjallaire add COPYING and NOTICE files
jjallaire authored
10
334f6c8 @jjallaire sync readme to welcome
jjallaire authored
11 * Build useful web applications with only a few lines of code—no JavaScript required.
12 * Shiny applications are automatically "live" in the same way that spreadsheets are live. Outputs change instantly as users modify inputs, without requiring a reload of the browser.
13 * Shiny user interfaces can be built entirely using R, or can be written directly in HTML, CSS, and JavaScript for more flexibility.
14 * Works in any R environment (Console R, Rgui for Windows or Mac, ESS, StatET, RStudio, etc.)
a501458 @jjallaire Refer to Bootstrap without Twitter preface; link explicitly to v2.3.2…
jjallaire authored
15 * Attractive default UI theme based on [Bootstrap](http://getbootstrap.com/2.3.2/).
334f6c8 @jjallaire sync readme to welcome
jjallaire authored
16 * A highly customizable slider widget with built-in support for animation.
17 * Pre-built output widgets for displaying plots, tables, and printed output of R objects.
3016136 @yihui websockets has been changed to httpuv
yihui authored
18 * Fast bidirectional communication between the web browser and R using the [httpuv](https://github.com/rstudio/httpuv) package.
334f6c8 @jjallaire sync readme to welcome
jjallaire authored
19 * Uses a [reactive](http://en.wikipedia.org/wiki/Reactive_programming) programming model that eliminates messy event handling code, so you can focus on the code that really matters.
20 * Develop and redistribute your own Shiny widgets that other developers can easily drop into their own applications (coming soon!).
5a0921e @jjallaire flesh out Readme.md
jjallaire authored
21
d234ab0 @jjallaire tweaks to readme
jjallaire authored
22 ## Installation
7431445 @jjallaire update readme
jjallaire authored
23
15d62d4 @jcheng5 Add instructions for installing from GitHub
jcheng5 authored
24 To install the stable version from CRAN, simply run the following from an R console:
09f0f85 @jjallaire update README with installation instructions
jjallaire authored
25
26 ```r
99b1ed5 @jcheng5 Update install instructions
jcheng5 authored
27 install.packages("shiny")
09f0f85 @jjallaire update README with installation instructions
jjallaire authored
28 ```
5a0921e @jjallaire flesh out Readme.md
jjallaire authored
29
15d62d4 @jcheng5 Add instructions for installing from GitHub
jcheng5 authored
30 To install the latest development builds directly from GitHub, run this instead:
31
32 ```r
33 if (!require("devtools"))
34 install.packages("devtools")
1ae65bb @wch Fix URL
wch authored
35 devtools::install_github("rstudio/shiny")
15d62d4 @jcheng5 Add instructions for installing from GitHub
jcheng5 authored
36 ```
37
7431445 @jjallaire update readme
jjallaire authored
38 ## Getting Started
5a0921e @jjallaire flesh out Readme.md
jjallaire authored
39
3999f4d @trestletech Updated external links to the Shiny Dev Center.
trestletech authored
40 To learn more we highly recommend you check out the [Shiny Tutorial](http://shiny.rstudio.com/tutorial/). The tutorial explains the framework in-depth, walks you through building a simple application, and includes extensive annotated examples.
5a0921e @jjallaire flesh out Readme.md
jjallaire authored
41
004b7c7 @wch Add mailing list information to README
wch authored
42 We hope you enjoy using Shiny. If you have general questions about using Shiny, please use the Shiny [mailing list](https://groups.google.com/forum/#!forum/shiny-discuss). For bug reports, please use the [issue tracker](https://github.com/rstudio/shiny/issues).
5a0921e @jjallaire flesh out Readme.md
jjallaire authored
43
4392676 @wch Add Bootstrap 3 note to README
wch authored
44 ## Bootstrap 3 migration
45
85bde2b @wch Fix reference to old shiny version number
wch authored
46 Shiny versions 0.10.2.2 and below used the Bootstrap 2 web framework. After 0.10.2.2, Shiny switched to Bootstrap 3. For most users, the upgrade should be seamless. However, if you have have customized your HTML-generating code to use features specific to Bootstrap 2, you may need to update your code to work with Bootstrap 3.
4392676 @wch Add Bootstrap 3 note to README
wch authored
47
238f54e @wch Change name of shinyBootstrap2 package to shinybootstrap2
wch authored
48 If you do not wish to update your code at this time, you can use the [shinybootstrap2](https://github.com/rstudio/shinybootstrap2) package for backward compatibility.
4392676 @wch Add Bootstrap 3 note to README
wch authored
49
99c1069 @wch Add instructions for installing old version
wch authored
50 If you prefer to install an older version of Shiny, you can do it using the devtools package:
51
52 ```R
9599b14 @wch Add note about tools in main README
wch authored
53 devtools::install_version("shiny", version = "0.10.2.2")
99c1069 @wch Add instructions for installing old version
wch authored
54 ```
55
9599b14 @wch Add note about tools in main README
wch authored
56 ## Development notes
57
58 The Javascript code in Shiny is minified using tools that run on Node.js. See the tools/ directory for more information.
59
5a0921e @jjallaire flesh out Readme.md
jjallaire authored
60 ## License
61
fb37e32 @jjallaire updated readme
jjallaire authored
62 The shiny package is licensed under the GPLv3. See these files in the inst directory for additional details:
5a0921e @jjallaire flesh out Readme.md
jjallaire authored
63
64 - COPYING - shiny package license (GPLv3)
65 - NOTICE - Copyright notices for additional included software
Something went wrong with that request. Please try again.