Skip to content

Commit c41a1c5

Browse files
add code of conduct and flesh out readme
1 parent 9ba54db commit c41a1c5

File tree

3 files changed

+43
-4
lines changed

3 files changed

+43
-4
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
^roffice\.Rproj$
22
^\.Rproj\.user$
3+
^CODE_OF_CONDUCT\.md$

CODE_OF_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: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@
44

55
> Alan Dilpert session at [rstudio::conf](http://www.cvent.com/events/rstudio-conf-austin/agenda-dd6d75526f3c4554b67c4de32aeffb47.aspx)
66
7-
In `roffice` we illustrate some alternate techniques
7+
In `roffice` we illustrate some alternate techniques for building an `htmlwidget` around the extensive set of components from the Microsoft [Fabric](https://developer.microsoft.com/en-us/fabric) project. Instead of using a `yarn` build with JavaScript modules, we use the `umd` build of Fabric. Many React libraries do not offer a standalone build. If the component or component set does provide a standalone build, then we can avoid the potentially difficult JavaScript/npm/yarn steps, and directly use only a couple of lines of JavaScript (see [officeuiwidget](https://github.com/timelyportfolio/roffice/blob/master/inst/htmlwidgets/officeuiwidget.js)).
8+
9+
```
10+
// trick to include React Fragment component
11+
// which is like an empty container
12+
Fabric.Fragment = React.Fragment;
13+
14+
// office-ui-fabric namespaces all the components with Fabric
15+
reactR.reactWidget('officeuiwidget', 'output', Fabric);
16+
```
817

918
## Installation
1019

@@ -15,11 +24,15 @@ devtools::install_github("timelyportfolio/reactR@enhancements")
1524
devtools::install_github("timelyportfolio/roffice")
1625
```
1726

18-
## Example
27+
## Examples
1928

20-
This is a basic example which shows you how to solve a common problem:
29+
There are multiple examples [here](https://github.com/timelyportfolio/roffice/tree/master/inst/examples), but for the sake of including some code in this Readme.
2130

2231
``` r
23-
## basic example code
32+
library(reactR)
33+
library(roffice)
2434
```
2535

36+
## Code of Conduct
37+
38+
We would love help, comments, feedback, and other contributions, but please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. Violations, meanness, and any other behavior that is not inclusive and welcoming will not be tolerated.

0 commit comments

Comments
 (0)