Badge and installation instructions

krlmlr · krlmlr · commit f67cc2fa45b4 · 2019-07-09T01:15:52.000+02:00
diff --git a/README.Rmd b/README.Rmd
@@ -4,13 +4,18 @@ output:
     html_preview: false
 ---
 
+<!-- badges: start -->
+[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
 [![Travis-CI Build Status](https://travis-ci.org/tidyverse/blob.svg?branch=master)](https://travis-ci.org/tidyverse/blob)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/blob)](https://cran.r-project.org/package=blob)
 [![Coverage Status](https://codecov.io/gh/tidyverse/blob/branch/master/graph/badge.svg)](https://codecov.io/github/tidyverse/blob?branch=master)
+<!-- badges: end -->
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
 ```{r, include = FALSE}
+pkgload::load_all()
+
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>",
@@ -28,9 +33,14 @@ In most cases you will not need to use this package explicitly: it will be used
 
 ## Installation
 
-You can install blob from github with:
+```r
+# The easiest way to get blob is to install the whole tidyverse:
+install.packages("tidyverse")
+
+# Alternatively, install just blob:
+install.packages("blob")
 
-```{r gh-installation, eval = FALSE}
+# Or the the development version from GitHub:
 # install.packages("devtools")
 devtools::install_github("tidyverse/blob")
 ```
diff --git a/README.md b/README.md
@@ -1,9 +1,14 @@
 
+<!-- badges: start -->
+
+[![Lifecycle:
+maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
 [![Travis-CI Build
 Status](https://travis-ci.org/tidyverse/blob.svg?branch=master)](https://travis-ci.org/tidyverse/blob)
 [![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/blob)](https://cran.r-project.org/package=blob)
 [![Coverage
 Status](https://codecov.io/gh/tidyverse/blob/branch/master/graph/badge.svg)](https://codecov.io/github/tidyverse/blob?branch=master)
+<!-- badges: end -->
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
@@ -21,9 +26,14 @@ databases or binary file formats.
 
 ## Installation
 
-You can install blob from github with:
-
 ``` r
+# The easiest way to get blob is to install the whole tidyverse:
+install.packages("tidyverse")
+
+# Alternatively, install just blob:
+install.packages("blob")
+
+# Or the the development version from GitHub:
 # install.packages("devtools")
 devtools::install_github("tidyverse/blob")
 ```
@@ -33,6 +43,8 @@ devtools::install_github("tidyverse/blob")
 To create a blob, use `blob()`, `new_blob()` or `as_blob()`:
 
 ``` r
+library(blob)
+
 x1 <- charToRaw("Good morning")
 x2 <- as.raw(c(0x48, 0x65, 0x6c, 0x6c, 0x6f))
 
