Skip to content

Commit

Permalink
Updates to packaging
Browse files Browse the repository at this point in the history
- no longer need current-release folder
- updated README with github_install instructions
  • Loading branch information
Chris Park committed Dec 14, 2016
1 parent 131fda0 commit b7ecfd5
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 6 deletions.
5 changes: 3 additions & 2 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
^README\.Rmd$ # An Rmarkdown file used to generate README.md
^cran-comments\.md$ # Comments for CRAN submission
^NEWS.md$ # A news file written in Markdown
^.*\.Rproj$
^\.Rproj\.user$
^\.travis\.yml$
current-release$
docker$
examples$
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Package: rosetteApi
Type: Package
Title: Rosette API
Version: 1.4.2
Date: 2016-10-05
Date: 2016-12-12
Author: Sam Hausmann [aut, cre],
Chris Park [ctb],
Hannah Gaudet [ctb]
Expand Down
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,24 @@
This is the Rosette API client binding for R.

## Getting Started
Install the module with: `install.packages('rosetteAPI')`
Install the module with: `install.packages('rosetteAPI')`, which will pull the release from CRAN

OR (recommended), since CRAN is potentially behind the latest release, due to the hurdles one must traverse in order to publish, install from GitHub using ```install_github("rosette-api/r-binding")```

Command line example:

```
$ R -e 'install.packages("devtools")
$ cat > installrosette.R << EOF
> library(devtools)
> install_github("rosette-api/r-binding")
> q()
> EOF
$ R --no-save < installrosettte.R
```


OR

Ensure you're in the `current release` folder and run the command `R CMD INSTALL rosetteApi_<version>.tar.gz`


## Example using the Rosette API language detection endpoint
Expand Down
Binary file removed current-release/rosetteApi_1.4.2.tar.gz
Binary file not shown.
Binary file added man/rosetteApi_1.4.2.pdf
Binary file not shown.

0 comments on commit b7ecfd5

Please sign in to comment.