From 21e02d5a49b19139894b69ce6445b973c9f2b24e Mon Sep 17 00:00:00 2001 From: Jason Fisher <jfisher@usgs.gov> Date: Thu, 16 Jan 2025 11:45:24 -0800 Subject: [PATCH] update description in readme --- README.Rmd | 8 ++++++-- README.md | 35 ++++++++++++++++++++--------------- 2 files changed, 26 insertions(+), 17 deletions(-) diff --git a/README.Rmd b/README.Rmd index 0013d4b..5a315e3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -12,7 +12,11 @@ output: ## Description -The **webmap** package in [R] is a tool that leverages the JavaScript [Leaflet] library to create dynamic web maps. It includes base layers from [The National Map] (TNM), which provides access to geospatial information about the landscape of the United States and its territories. However, it is important to note that base layers outside these areas are unavailable at higher spatial scales. While [TNM services] are consistently [monitored] for reliability, their availability outside of standard government working hours cannot be guaranteed. The **webmap** package is designed to work in conjunction with the [Leaflet for R] package. Furthermore, it comes equipped with a variety of utility functions that enable you to enhance your web map with additional features. +The **webmap** package in [R] leverages the JavaScript [Leaflet] library to create dynamic web maps. It seamlessly integrates with base layers provided by [The National Map](TNM), offering essential geospatial information about the landscapes of the United States and its territories. + +Users should be aware that detailed base layers for areas outside the United States may not be available at higher spatial scales. While The National Map [services] are continuously [monitored] for reliability, availability outside of standard government working hours cannot be assured. + +Designed to complement the [Leaflet for R] package, the **webmap** package enhances mapping capabilities by providing a range of utility functions that allow users to enrich their web maps with additional features, resulting in engaging and effective visualizations. This makes the process of creating impactful web maps both straightforward and accessible for users of varying skill levels. ## Installation @@ -141,5 +145,5 @@ cat(s) [Shiny]: https://shiny.posit.co/ [leaflet-search library]: https://github.com/stefanocudini/leaflet-search [Leaflet.fullscreen library]: https://github.com/Leaflet/Leaflet.fullscreen -[TNM services]: https://apps.nationalmap.gov/services/ +[services]: https://apps.nationalmap.gov/services/ [monitored]: https://stats.uptimerobot.com/gxzRZFARLZ diff --git a/README.md b/README.md index 4d42c8c..7ecb0b0 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,26 @@ ## Description -The **webmap** package in [R](https://www.r-project.org/) is a tool that -leverages the JavaScript [Leaflet](https://leafletjs.com/) library to -create dynamic web maps. It includes base layers from [The National -Map](https://www.usgs.gov/programs/national-geospatial-program/national-map) -(TNM), which provides access to geospatial information about the -landscape of the United States and its territories. However, it is -important to note that base layers outside these areas are unavailable -at higher spatial scales. While [TNM -services](https://apps.nationalmap.gov/services/) are consistently -[monitored](https://stats.uptimerobot.com/gxzRZFARLZ) for reliability, -their availability outside of standard government working hours cannot -be guaranteed. The **webmap** package is designed to work in conjunction -with the [Leaflet for R](https://rstudio.github.io/leaflet/) package. -Furthermore, it comes equipped with a variety of utility functions that -enable you to enhance your web map with additional features. +The **webmap** package in [R](https://www.r-project.org/) leverages the +JavaScript [Leaflet](https://leafletjs.com/) library to create dynamic +web maps. It seamlessly integrates with base layers provided by [The +National Map](TNM), offering essential geospatial information about the +landscapes of the United States and its territories. + +Users should be aware that detailed base layers for areas outside the +United States may not be available at higher spatial scales. While The +National Map [services](https://apps.nationalmap.gov/services/) are +continuously [monitored](https://stats.uptimerobot.com/gxzRZFARLZ) for +reliability, availability outside of standard government working hours +cannot be assured. + +Designed to complement the [Leaflet for +R](https://rstudio.github.io/leaflet/) package, the **webmap** package +enhances mapping capabilities by providing a range of utility functions +that allow users to enrich their web maps with additional features, +resulting in engaging and effective visualizations. This makes the +process of creating impactful web maps both straightforward and +accessible for users of varying skill levels. ## Installation -- GitLab