Prepping package for beta release

.lintr

@@ -0,0 +1,6 @@
+linters: linters_with_defaults(
+    line_length_linter = line_length_linter(120)
+
+  )
+
+encoding: "UTF-8"

DESCRIPTION

@@ -45,8 +45,8 @@ Imports:
 RoxygenNote: 7.2.3
 Depends: 
     R (>= 3.5.0)
-URL: https://github.com/billingtt/acledR, https://billingtt.github.io/acledR/, https://acled.github.io/acledR/
-BugReports: https://github.com/billingtt/acledR/issues
+URL: https://github.com/ACLED/acledR, https://acled.github.io/acledR/
+BugReports: https://github.com/ACLED/acledR/issues
 Suggests: 
     knitr,
     janitor,

README.Rmd

@@ -20,6 +20,11 @@ knitr::opts_chunk$set(
 [![codecov](https://codecov.io/gh/ACLED/acledR/graph/badge.svg?token=TDJodXhEvx)](https://codecov.io/gh/ACLED/acledR)
 <!-- badges: end -->
 
+Welcome to ACLED's official R package! With this package we want to bring you an even more convenient way to access ACLED data, building on top of our existing API. 
+
+In this repo you can find the source code of the package, as well as the documentation. You can also visit https://acled.github.io/acledR/ for more information and walkthroughs on how to use the package.
+
+
 # Overview
 
 This package provides tools to extract and manipulate data from the [Armed Conflict Location and Event Data Project (ACLED)](https://acleddata.com/). 
@@ -39,7 +44,7 @@ Since the package repo is currently private, you need to tell R and Github that
 usethis::create_github_token()
 ```
 
-After you've copied the PAT from the browser, return to R and run this, which will store the PAT locally.
+After you've copied the PAT from the browser and saved it somewhere safe, return to R and run this, which will store the PAT locally.
 
 ```{r, eval=F}
 # paste the token where it says YourPAT
@@ -48,15 +53,6 @@ credentials::set_github_pat("YourPAT")
 Sys.getenv("GITHUB_PAT")
 ```
 
-I recommend also setting the PAT in your `.Rprofile` so it's stored for all R sessions (i.e., you don't have to save the PAT and paste it in each time you re-install).
-
-```{r, eval=F}
-# to set your PAT for all R sessions, run
-file.edit(file.path("~", ".Rprofile"))
-# and then paste credentials::set_github_pat("YourPAT") into the .Rprofile script
-# save the file
-```
-
 Now you can install the package and it will automatically locate your PAT.
 
 ```{r, eval=F}
@@ -67,8 +63,12 @@ devtools::install_github("ACLED/acledR")
 
 ## Installation (for public use) 
 
-Until the acledR package gets added into the Comprehensive R Archive Network (CRAN), users can utilize devtools to install the package from Github. Thankfully, the installation is rather simple. You can install it through the following code:
-
+The package is on the process to get submited to the Comprehensive R Archive Network (CRAN). In the meantime, you can install the package from Github.
 ```{r, eval = F}
 devtools::install_github("ACLED/acledR") ## if you are interested in a particular branch, please add a 'ref' argument. 
 ```
+
+Once the package is uploaded to CRAN, you can install it with the following command:
+```{r, eval = F}
+install.packages("acledR")
+```