diff --git a/README.Rmd b/README.Rmd
index f279081..eada380 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -21,22 +21,27 @@ knitr::opts_chunk$set(
--
-**The goal of abstr is to provide an R interface to the [A/B Street](https://github.com/a-b-street/abstreet#ab-street) transport planning/simulation game.
-Currently it provides a way to convert aggregated origin-destination data, combined with data on buildings representing origin and destination locations, into `.json` files that can be directly imported into the A/B Street city simulation.**
+
+**abstr provides an R interface to the [A/B Street](https://github.com/a-b-street/abstreet#ab-street) transport system simulation and network editing software. It provides functions for converting origin-destination data, combined with data on buildings representing origin and destination locations, into `.json` files that can be directly imported into the A/B Street city simulation.**
See the formats page in the [A/B Street documentation](https://a-b-street.github.io/docs/tech/dev/formats/scenarios.html) for details of the schema that the package outputs.
## Installation
You can install the released version of abstr from
-
-GitHub as follows:
+[CRAN](https://CRAN.R-project.org) with:
-```r
+```{r, eval=FALSE}
+install.packages("abstr")
+```
+
+Install the development version from GitHub as follows:
+
+```{r, eval=FALSE}
remotes::install_github("a-b-street/abstr")
```
-## Example
+## Usage
The example below shows how `abstr` can be used.
The input datasets include `sf` objects representing buildings, origin-destination (OD) data represented as desire lines and administrative zones representing the areas within which trips in the desire lines start and end.
diff --git a/README.md b/README.md
index 83af3dc..0dfeb54 100644
--- a/README.md
+++ b/README.md
@@ -10,10 +10,10 @@
##
-**The goal of abstr is to provide an R interface to the [A/B
+**abstr provides an R interface to the [A/B
Street](https://github.com/a-b-street/abstreet#ab-street) transport
-planning/simulation game. Currently it provides a way to convert
-aggregated origin-destination data, combined with data on buildings
+system simulation and network editing software. It provides functions
+for converting origin-destination data, combined with data on buildings
representing origin and destination locations, into `.json` files that
can be directly imported into the A/B Street city simulation.**
@@ -24,13 +24,19 @@ for details of the schema that the package outputs.
## Installation
You can install the released version of abstr from
- GitHub as follows:
+[CRAN](https://CRAN.R-project.org) with:
+
+``` r
+install.packages("abstr")
+```
+
+Install the development version from GitHub as follows:
``` r
remotes::install_github("a-b-street/abstr")
```
-## Example
+## Usage
The example below shows how `abstr` can be used. The input datasets
include `sf` objects representing buildings, origin-destination (OD)
@@ -44,7 +50,6 @@ U.S.
``` r
library(abstr)
library(tmap) # for map making
-#> Warning: package 'tmap' was built under R version 4.0.5
tm_shape(montlake_zones) + tm_polygons(col = "grey") +
tm_shape(montlake_buildings) + tm_polygons(col = "blue") +
tm_style("classic")
@@ -72,7 +77,7 @@ The final piece of the `abstr` puzzle is OD data.
``` r
head(montlake_od)
-#> # A tibble: 6 x 6
+#> # A tibble: 6 × 6
#> o_id d_id Drive Transit Bike Walk
#>
#> 1 281 361 23 1 2 14
diff --git a/man/figures/README-input-1.png b/man/figures/README-input-1.png
index ed29c64..c4ccf70 100644
Binary files a/man/figures/README-input-1.png and b/man/figures/README-input-1.png differ
diff --git a/man/figures/README-outputplot-1.png b/man/figures/README-outputplot-1.png
index 1713ae0..444d15f 100644
Binary files a/man/figures/README-outputplot-1.png and b/man/figures/README-outputplot-1.png differ