Merge pull request #43 from lorenzwalthert/update_readme

tidy up README

Author: lorenzwalthert

DESCRIPTION

@@ -21,7 +21,8 @@ Suggests:
     knitr,
     rmarkdown,
     rstudioapi,
-    testthat
+    testthat,
+    pkgload
 Remotes:
     r-lib/pkgload,
     krlmlr/utf8

README.Rmd

@@ -18,62 +18,40 @@ knitr::opts_chunk$set(
 # styler
 
 [![Build Status](https://travis-ci.org/krlmlr/styler.svg?branch=master)](https://travis-ci.org/krlmlr/styler)
-[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/krlmlr/styler?branch=master&svg=true)](https://ci.appveyor.com/project/lorenzwalthert/styler)
+[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/krlmlr/styler?branch=master&svg=true)](https://ci.appveyor.com/project/krlmlr/styler)
 [![Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)
 
 The goal of styler is to provide non-invasive pretty-printing of R source code 
 while adhering to the [tidyverse](https://github.com/tidyverse/style) formatting 
 rules. Support for custom style guides is planned.
 
-You can style a simple character vector of code with `style_text()`, a directory 
-with `style_dir()`or a whole R package with `style_pkg()`.
+You can style a simple character vector of code with `style_text()`:
 ```{r echo=FALSE, message=FALSE}
-devtools::load_all()
+pkgload::load_all()
+library("magrittr")
 #knitr::opts_chunk$set(comment = NA)
 ```
 
 
 ```{r}
 ugly_code <- "a<-function( x){1+1}           "
-style_text(ugly_code)
+style_text(ugly_code) %>%
+  cat(sep = "\n")
 
 ```
 
-You can find more information on the wiki of [Google Summer of Code 2017](https://github.com/rstats-gsoc/gsoc2017/wiki/Noninvasive-source-code-formatting) 
-or check out the [pkgdown](https://krlmlr.github.io/styler/) page.
-
-In the following, we present a dirty file and how it is styled with styler. 
-The file can either be tidied, which is a less strict form of styling with an 
-emphasis on preserving the programmer's intentions - or cleaned, which means to 
-strictly apply the style guide at hand.
-
-## Dirty source file
+There are a few variants of `style_text()`:
 
-```{r}
-print_code <- function(x) {
-  knitr::asis_output(
-    paste(
-      c("```r", "", "", "# ------", x, "# ------", "```"),
-      collapse = "\n"))
-}
-
-dirty <- readLines(here::here("tests/testthat/example/in.R"))
+* `style_file()` styles a single .R file.
+* `style_dir()` styles all .R files in a directory.
+* `style_pkg()` styles the source files of an R package.
+* An RStudio Addin that styles the active file .R file
 
-print_code(dirty)
+```{r, out.width = "650px", echo = FALSE}
+knitr::include_graphics("https://raw.githubusercontent.com/lorenzwalthert/some_raw_data/master/styler_0.1.gif")
 ```
 
-## Tidied file
 
-```{r}
-tidy <- style_text(dirty, get_transformers(strict = FALSE))
 
-print_code(tidy)
-```
-
-## Cleaned file
-
-```{r}
-clean <- styler::style_text(dirty)
-
-print_code(clean)
-```
+You can find more information on the wiki of [Google Summer of Code 2017](https://github.com/rstats-gsoc/gsoc2017/wiki/Noninvasive-source-code-formatting) 
+or check out the [pkgdown](https://krlmlr.github.io/styler/) page.