Skip to content

Commit a5dfd7b

Browse files
add a basic README.md and code of conduct
1 parent e7e4bc3 commit a5dfd7b

File tree

3 files changed

+65
-0
lines changed

3 files changed

+65
-0
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
^.*\.Rproj$
22
^\.Rproj\.user$
33
^\build
4+
^CONDUCT\.md$

CONDUCT.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect all people who
4+
contribute through reporting issues, posting feature requests, updating documentation,
5+
submitting pull requests or patches, and other activities.
6+
7+
We are committed to making participation in this project a harassment-free experience for
8+
everyone, regardless of level of experience, gender, gender identity and expression,
9+
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
10+
11+
Examples of unacceptable behavior by participants include the use of sexual language or
12+
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
13+
insults, or other unprofessional conduct.
14+
15+
Project maintainers have the right and responsibility to remove, edit, or reject comments,
16+
commits, code, wiki edits, issues, and other contributions that are not aligned to this
17+
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
18+
from the project team.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
21+
opening an issue or contacting one or more of the project maintainers.
22+
23+
This Code of Conduct is adapted from the Contributor Covenant
24+
(http:contributor-covenant.org), version 1.0.0, available at
25+
http://contributor-covenant.org/version/1/0/0/

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# reactR
2+
3+
A convenience function with local dependencies for using [`React`](https://facebook.github.io/react) in `R`. This is modeled after the `html_dependency_*` functions from RStudio's [`rmarkdown`](https://github.com/rstudio/rmarkdown) package.
4+
5+
## Installation
6+
7+
You can install reactR from github with:
8+
9+
```R
10+
# install.packages("devtools")
11+
devtools::install_github("timelyportfolio/reactR")
12+
```
13+
14+
## Example
15+
16+
```R
17+
library(reactR)
18+
library(htmltools)
19+
20+
browsable(attachDependencies(
21+
tags$script(
22+
"
23+
ReactDOM.render(
24+
React.createElement(
25+
'h1',
26+
null,
27+
'Powered by React'
28+
),
29+
document.body
30+
)
31+
"
32+
),
33+
html_dependency_react()
34+
))
35+
```
36+
37+
## Contributing and Code of Conduct
38+
39+
I welcome contributors. Help make this package great. 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 its terms.

0 commit comments

Comments
 (0)