Merge pull request #101 from atorus-research/100_95_readme_description

100 95 readme description
pharmaverse · Jun 21, 2022 · 81afb8e · 81afb8e
2 parents e576031 + 1303da3
commit 81afb8e
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 7 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -46,7 +46,7 @@ Imports:
     miniUI,
     rstudioapi,
     shiny,
-    sessioninfo,
+    sessioninfo (>= 1.2),
     stringi,
     waiter,
     tibble

diff --git a/README.Rmd b/README.Rmd
@@ -26,10 +26,16 @@ The goal of logrx is to facilitate logging in a clinical environment with the go
 
 ## Installation
 
-This package is still in development and currently is only available from GitHub. To install the development version run the following:
+This package is available from CRAN and can be installed by running: 
 
 ```{r, eval = FALSE}
-devtools::install_github("atorus-research/logrx")
+install.packages("logrx")
+```
+
+To get the latest development version use:
+
+```{r, eval = FALSE}
+devtools::install_github("atorus-research/logrx", ref = "dev")
 ```
 
 ## What is ```logrx``` ?

diff --git a/README.md b/README.md
@@ -18,11 +18,16 @@ with the goal of making code easily traceable and reproducible.
 
 ## Installation
 
-This package is still in development and currently is only available
-from GitHub. To install the development version run the following:
+This package is available from CRAN and can be installed by running:
 
 ``` r
-devtools::install_github("atorus-research/logrx")
+install.packages("logrx")
+```
+
+To get the latest development version use:
+
+``` r
+devtools::install_github("atorus-research/logrx", ref = "dev")
 ```
 
 ## What is `logrx` ?

diff --git a/inst/rstudio/addins.dcf b/inst/rstudio/addins.dcf
@@ -1,4 +1,5 @@
-Name: logrx
+Name: Submit with logrx
 Description: Runs a file using `axecute()`
 Binding: logrxAddin
 Interactive: true
+