add readme

.Rbuildignore

@@ -4,3 +4,4 @@
 ^docs$
 ^pkgdown$
 ^\.github$
+^README\.Rmd$

README.Rmd

@@ -0,0 +1,52 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "##",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# sshicm
+
+<!-- badges: start -->
+[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-cyan.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![CRAN](https://www.r-pkg.org/badges/version/sshicm)](https://CRAN.R-project.org/package=sshicm)
+[![R-universe](https://stscl.r-universe.dev/badges/sshicm?color=cyan)](https://stscl.r-universe.dev/sshicm)
+<!-- badges: end -->
+
+**Information Consistency-Based Measures for Spatial Stratified Heterogeneity**
+
+## Installation
+
+- Install from [CRAN](https://CRAN.R-project.org/package=sshicm) with:
+
+``` r
+install.packages("sshicm", dep = TRUE)
+```
+
+- Install binary version from [R-universe](https://stscl.r-universe.dev/sshicm) with:
+
+``` r
+install.packages("sshicm",
+                 repos = c("https://stscl.r-universe.dev",
+                           "https://cloud.r-project.org"),
+                 dep = TRUE)
+```
+
+- Install from source code on [GitHub](https://github.com/stscl/sshicm) with:
+
+```r
+if (!requireNamespace("devtools")) {
+    install.packages("devtools")
+}
+devtools::install_github("stscl/sshicm",
+                         build_vignettes = TRUE,
+                         dep = TRUE)
+```

README.md

@@ -0,0 +1,45 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# sshicm
+
+<!-- badges: start -->
+
+[![Lifecycle:
+experimental](https://img.shields.io/badge/lifecycle-experimental-cyan.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![CRAN](https://www.r-pkg.org/badges/version/sshicm)](https://CRAN.R-project.org/package=sshicm)
+[![R-universe](https://stscl.r-universe.dev/badges/sshicm?color=cyan)](https://stscl.r-universe.dev/sshicm)
+<!-- badges: end -->
+
+**Information Consistency-Based Measures for Spatial Stratified
+Heterogeneity**
+
+## Installation
+
+- Install from [CRAN](https://CRAN.R-project.org/package=sshicm) with:
+
+``` r
+install.packages("sshicm", dep = TRUE)
+```
+
+- Install binary version from
+  [R-universe](https://stscl.r-universe.dev/sshicm) with:
+
+``` r
+install.packages("sshicm",
+                 repos = c("https://stscl.r-universe.dev",
+                           "https://cloud.r-project.org"),
+                 dep = TRUE)
+```
+
+- Install from source code on [GitHub](https://github.com/stscl/sshicm)
+  with:
+
+``` r
+if (!requireNamespace("devtools")) {
+    install.packages("devtools")
+}
+devtools::install_github("stscl/sshicm",
+                         build_vignettes = TRUE,
+                         dep = TRUE)
+```