Edit README

Author: jennybc

README.Rmd

@@ -8,7 +8,8 @@ output: github_document
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>",
-  fig.path = "man/figures/README-"
+  fig.path = "man/figures/README-",
+  out.width = "100%"
 )
 ```
 
@@ -24,7 +25,13 @@ The goal of usethis is to automate many common package and analysis setup tasks.
 
 ## Installation
 
-You can install the development version of usethis from github with:
+Install the released version of usethis from CRAN:
+
+```{r, eval = FALSE}
+install.packages("usethis")
+```
+
+Or install the development version from GitHub with:
 
 ```{r, eval = FALSE}
 # install.packages("devtools")
@@ -33,7 +40,13 @@ devtools::install_github("r-lib/usethis")
 
 ## Usage
 
-All `use_*` functions operate on the current directory unless you specify the `base_path` argument. `✔` indicates that usethis has setup everything for you. `●` indicates that you'll need to do some work yourself.
+Most `use_*()` functions operate on the *current project*. If you've just used usethis to create a new package or project, that will be the current project. Otherwise usethis tries to confirm that current working directory can be recognized as a project. Use `proj_get()` and `proj_set()` for manual intervention. Some functions have no strong connections to projects and will expect you to provide a path.
+
+usethis is quite chatty, explaining what it's doing and assigning you tasks. `✔` indicates something usethis has done for you. `●` indicates that you'll need to do some work yourself.
+
+Below is a quick look at how usethis can help to set up a package.
+
+*Note: usethis is gaining more and more functionality for analytical project that are not packages. Stay tuned.*
 
 ```{r}
 library(usethis)

README.md

@@ -10,7 +10,13 @@ The goal of usethis is to automate many common package and analysis setup tasks.
 Installation
 ------------
 
-You can install the development version of usethis from github with:
+Install the released version of usethis from CRAN:
+
+``` r
+install.packages("usethis")
+```
+
+Or install the development version from GitHub with:
 
 ``` r
 # install.packages("devtools")
@@ -20,7 +26,13 @@ devtools::install_github("r-lib/usethis")
 Usage
 -----
 
-All `use_*` functions operate on the current directory unless you specify the `base_path` argument. `✔` indicates that usethis has setup everything for you. `●` indicates that you'll need to do some work yourself.
+Most `use_*()` functions operate on the *current project*. If you've just used usethis to create a new package or project, that will be the current project. Otherwise usethis tries to confirm that current working directory can be recognized as a project. Use `proj_get()` and `proj_set()` for manual intervention. Some functions have no strong connections to projects and will expect you to provide a path.
+
+usethis is quite chatty, explaining what it's doing and assigning you tasks. `✔` indicates something usethis has done for you. `●` indicates that you'll need to do some work yourself.
+
+Below is a quick look at how usethis can help to set up a package.
+
+*Note: usethis is gaining more and more functionality for analytical project that are not packages. Stay tuned.*
 
 ``` r
 library(usethis)
@@ -54,7 +66,7 @@ use_dev_package("callr")
 # Set up various packages ---------------------------------------------
 use_roxygen_md()
 #> ✔ Setting Roxygen field in DESCRIPTION to 'list(markdown = TRUE)'
-#> ✔ Setting RoxygenNote field in DESCRIPTION to '6.0.1'
+#> ✔ Setting RoxygenNote field in DESCRIPTION to '6.0.1.9000'
 #> ● Re-document
 
 use_rcpp()
@@ -71,18 +83,13 @@ use_rcpp()
 use_revdep()
 #> ✔ Creating 'revdep/'
 #> ✔ Adding '^revdep$' to '.Rbuildignore'
-#> ✔ Adding 'revdep/checks' to './.gitignore'
-#> ✔ Adding 'revdep/library' to './.gitignore'
-#> ✔ Adding 'revdep/checks.noindex' to './.gitignore'
-#> ✔ Adding 'revdep/library.noindex' to './.gitignore'
-#> ✔ Adding 'revdep/data.sqlite' to './.gitignore'
+#> ✔ Adding 'checks', 'library', 'checks.noindex', 'library.noindex', 'data.sqlite', '*.html' to 'revdep/.gitignore'
 #> ✔ Writing 'revdep/email.yml'
 #> ● Run checks with `revdepcheck::revdep_check(num_workers = 4)`
 
 # Set up other files -------------------------------------------------
 use_readme_md()
 #> ✔ Writing 'README.md'
-#> ● Edit 'README.md'
 
 use_news_md()
 #> ✔ Writing 'NEWS.md'