crn

SymbolixAU · Aug 30, 2023 · 16f527c · 16f527c
1 parent 602a7ae
commit 16f527c
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -11,3 +11,4 @@ inst/cppapi/*
 ^pkgdown$
 ^\.github$
 ^vignettes*
+^CRAN-SUBMISSION$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -5,9 +5,12 @@ Version: 0.1.0
 Date: 2023-08-29
 Authors@R: c(
     person("David", "Cooley", ,"[email protected]", role = c("aut", "cre")),
-    person("Ray", "Shao", ,"[email protected]", role = c("ctb"))
+    person("Ray", "Shao", ,"[email protected]", role = c("aut"))
     )
-Description: Provides access to Uber's 'H3' geospatial indexing system.
+Description: Provides access to Uber's 'H3' geospatial indexing system via 'h3lib' 
+  <https://CRAN.R-project.org/package=h3lib>. 'h3r' is designed to mimic the 'H3' 
+  Application Programming Interface (API) <https://h3geo.org/docs/api/indexing/>, 
+  so that any function in the API is also availble in 'h3r'.
 License: MIT + file LICENSE
 URL: https://symbolixau.github.io/h3r/
 BugReports: https://github.com/symbolixau/h3r/issues

diff --git a/README.Rmd b/README.Rmd
@@ -32,7 +32,7 @@ h3r::latLngToCell(
 ```
 
 
-Most of the [H3 API](https://h3geo.org/docs/api/indexing) is included in this package as R functions. The only exceptions are
+Most of the [H3 API](https://h3geo.org/docs/api/indexing/) is included in this package as R functions. The only exceptions are
 
 - stringToH3
 - h3ToString

diff --git a/README.md b/README.md
@@ -20,8 +20,8 @@ h3r::latLngToCell(
 # [1] "81be7ffffffffff" "8ebe6356311035f"
 ```
 
-Most of the [H3 API](https://h3geo.org/docs/api/indexing) is included in
-this package as R functions. The only exceptions are
+Most of the [H3 API](https://h3geo.org/docs/api/indexing/) is included
+in this package as R functions. The only exceptions are
 
 - stringToH3
 - h3ToString

diff --git a/src/h3r.c b/src/h3r.c