added readme.rmd to show r code

.Rbuildignore

@@ -2,3 +2,4 @@
 ^\.Rproj\.user$
 ^\.github$
 ^data-raw$
+^README\.Rmd$

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: arfit
-Title: Fits linear model in preesence of AR1 errors
+Title: Fits linear model in presence of AR1 errors
 Version: 0.0.0.9000
 Authors@R: 
     person("Andy", "Beet", , "[email protected]", role = c("aut", "cre"),

README.Rmd

@@ -0,0 +1,64 @@
+---
+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%"
+)
+```
+
+# arfit
+
+<!-- badges: start -->
+[![gh-pages](https://github.com/andybeet/arfit/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/andybeet/arfit/actions/workflows/pkgdown.yaml)
+[![gitleaks](https://github.com/andybeet/arfit/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/andybeet/arfit/actions/workflows/gitleaks.yml)
+<!-- badges: end -->
+
+The goal of arfit is to ...
+
+## Installation
+
+You can install the development version of `arfit` from [GitHub](https://github.com/andybeet/arfit) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("andybeet/arfit")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+library(arfit)
+## basic example code
+```
+
+## Contact
+
+| [andybeet](https://github.com/andybeet)                                                         |
+|-------------------------------------------------------------------------------------------------|
+| [![](https://avatars1.githubusercontent.com/u/22455149?s=100&v=4)](https://github.com/andybeet) |
+
+#### Legal disclaimer
+
+*This repository is a scientific product and is not official
+communication of the National Oceanic and Atmospheric Administration, or
+the United States Department of Commerce. All NOAA GitHub project code
+is provided on an ‘as is’ basis and the user assumes responsibility for
+its use. Any claims against the Department of Commerce or Department of
+Commerce bureaus stemming from the use of this GitHub project will be
+governed by all applicable Federal law. Any reference to specific
+commercial products, processes, or services by service mark, trademark,
+manufacturer, or otherwise, does not constitute or imply their
+endorsement, recommendation or favoring by the Department of Commerce.
+The Department of Commerce seal and logo, or the seal and logo of a DOC
+bureau, shall not be used in any manner to imply endorsement of any
+commercial product or activity by DOC or the United States Government.*
+

README.md

@@ -1,9 +1,34 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
 # arfit
 
-  <!-- badges: start -->
+<!-- badges: start -->
+
 [![gh-pages](https://github.com/andybeet/arfit/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/andybeet/arfit/actions/workflows/pkgdown.yaml)
 [![gitleaks](https://github.com/andybeet/arfit/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/andybeet/arfit/actions/workflows/gitleaks.yml)
-  <!-- badges: end -->
+<!-- badges: end -->
+
+The goal of arfit is to …
+
+## Installation
+
+You can install the development version of `arfit` from
+[GitHub](https://github.com/andybeet/arfit) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("andybeet/arfit")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+library(arfit)
+## basic example code
+```
 
 ## Contact