README

DESCRIPTION

@@ -6,10 +6,10 @@ Date: 2019-07-30
 Authors@R: c( person("Bob", "Rudis", email = "bob@rud.is", role =
         c("aut", "cre"), comment = c(ORCID = "0000-0001-5670-2640")) )
 Maintainer: Bob Rudis <bob@rud.is>
-Description: EmailRep is a system of crawlers, scanners and enrichment services 
-    that collects data on email addresses, domains, and internet personas.
-    EmailRep uses hundreds of data points from social media profiles, 
-    professional networking sites, dark web credential leaks, data breaches, 
+Description: EmailRep (<https://emailrep.io/>) is a system of crawlers, scanners 
+    and enrichment services that collects data on email addresses, domains, and 
+    internet personas. EmailRep uses hundreds of data points from social media 
+    profiles, professional networking sites, dark web credential leaks, data breaches, 
     phishing kits, phishing emails, spam lists, open mail relays, domain age and 
     reputation, deliverability, and more to predict the risk of an email address.
     Tools are provided to gather reputation information for emails.

R/emailrep-package.R

@@ -14,4 +14,6 @@
 #' @author Bob Rudis (bob@@rud.is)
 #' @import httr
 #' @importFrom jsonlite fromJSON
+#' @references <https://emailrep.io/>; <https://github.com/sublime-security/emailrep.io>;
+#'             <https://emailrep.io/docs/#emailrep-alpha-api>
 "_PACKAGE"

R/get-rep.R

@@ -2,6 +2,8 @@
 #'
 #' @param email the email to get rep for
 #' @param ... passed on to [httr::GET()]
+#' @references <https://emailrep.io/>; <https://github.com/sublime-security/emailrep.io>;
+#'             <https://emailrep.io/docs/#emailrep-alpha-api>
 #' @export
 #' @examples
 #' email_rep("bill@@microsoft.com")

README.Rmd

@@ -15,6 +15,10 @@ hrbrpkghelpr::stinking_badges()
 hrbrpkghelpr::yank_title_and_description()
 ```
 
+- <https://emailrep.io/>
+- <https://github.com/sublime-security/emailrep.io>
+- <https://emailrep.io/docs/#emailrep-alpha-api>
+
 ## What's Inside The Tin
 
 The following functions are implemented:

README.md

@@ -18,13 +18,18 @@ Check Email Address Reputation Against the ‘EmailRep’ API
 
 ## Description
 
-EmailRep is a system of crawlers, scanners and enrichment services that
-collects data on email addresses, domains, and internet personas.
-EmailRep uses hundreds of data points from social media profiles,
-professional networking sites, dark web credential leaks, data breaches,
-phishing kits, phishing emails, spam lists, open mail relays, domain age
-and reputation, deliverability, and more to predict the risk of an email
-address. Tools are provided to gather reputation information for emails.
+EmailRep (<https://emailrep.io/>) is a system of crawlers, scanners and
+enrichment services that collects data on email addresses, domains, and
+internet personas. EmailRep uses hundreds of data points from social
+media profiles, professional networking sites, dark web credential
+leaks, data breaches, phishing kits, phishing emails, spam lists, open
+mail relays, domain age and reputation, deliverability, and more to
+predict the risk of an email address. Tools are provided to gather
+reputation information for emails.
+
+  - <https://emailrep.io/>
+  - <https://github.com/sublime-security/emailrep.io>
+  - <https://emailrep.io/docs/#emailrep-alpha-api>
 
 ## What’s Inside The Tin
 
@@ -35,11 +40,17 @@ The following functions are implemented:
 ## Installation
 
 ``` r
+install.packages("emailrep", repos = "https://cinc.rud.is")
+# or
 remotes::install_git("https://git.rud.is/hrbrmstr/emailrep.git")
 # or
 remotes::install_git("https://git.sr.ht/~hrbrmstr/emailrep")
 # or
 remotes::install_gitlab("hrbrmstr/emailrep")
+# or
+remotes::install_bitbucket("hrbrmstr/emailrep")
+# or
+remotes::install_github("hrbrmstr/emailrep")
 ```
 
 NOTE: To use the ‘remotes’ install options you will need to have the
@@ -84,15 +95,15 @@ str( email_rep("bill@microsoft.com"), 2 )
 ##   ..$ spoofable                 : logi FALSE
 ##   ..$ spf_strict                : logi TRUE
 ##   ..$ dmarc_enforced            : logi TRUE
-##   ..$ profiles                  : chr [1:8] "spotify" "vimeo" "pinterest" "twitter" ...
+##   ..$ profiles                  : chr [1:8] "linkedin" "angellist" "spotify" "flickr" ...
 ```
 
 ## emailrep Metrics
 
-| Lang | \# Files | (%) | LoC |  (%) | Blank lines | (%) | \# Lines |  (%) |
-| :--- | -------: | --: | --: | ---: | ----------: | --: | -------: | ---: |
-| R    |        4 | 0.8 |  22 | 0.71 |           7 | 0.3 |       23 | 0.44 |
-| Rmd  |        1 | 0.2 |   9 | 0.29 |          16 | 0.7 |       29 | 0.56 |
+| Lang | \# Files | (%) | LoC |  (%) | Blank lines |  (%) | \# Lines |  (%) |
+| :--- | -------: | --: | --: | ---: | ----------: | ---: | -------: | ---: |
+| R    |        4 | 0.8 |  22 | 0.71 |           7 | 0.29 |       27 | 0.46 |
+| Rmd  |        1 | 0.2 |   9 | 0.29 |          17 | 0.71 |       32 | 0.54 |
 
 ## Code of Conduct
 

man/email_rep.Rd

@@ -17,3 +17,7 @@ Get email reputation
 \examples{
 email_rep("bill@microsoft.com")
 }
+\references{
+\url{https://emailrep.io/}; \url{https://github.com/sublime-security/emailrep.io};
+\url{https://emailrep.io/docs/#emailrep-alpha-api}
+}

man/emailrep.Rd

@@ -14,6 +14,10 @@ phishing kits, phishing emails, spam lists, open mail relays, domain age and
 reputation, deliverability, and more to predict the risk of an email address.
 Tools are provided to gather reputation information for emails.
 }
+\references{
+\url{https://emailrep.io/}; \url{https://github.com/sublime-security/emailrep.io};
+\url{https://emailrep.io/docs/#emailrep-alpha-api}
+}
 \seealso{
 Useful links:
 \itemize{