Include links to GitHub in DESCRIPTION and create basic README

Author: lsigut

.Rbuildignore

@@ -1,2 +1,4 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^README\.Rmd$
+^README-.*\.png$

DESCRIPTION

@@ -20,6 +20,8 @@ Description: This package provides utilities for eddy covariance data
     the automated quality checking and make data processing reproducible.
 Depends: R (>= 3.5.1)
 License: GPL (>= 2)
+URL: https://github.com/lsigut/openeddy
+BugReports: https://github.com/lsigut/openeddy/issues
 Date: 2018-09-18
 Encoding: UTF-8
 LazyData: true

README.Rmd

@@ -0,0 +1,30 @@
+---
+output:
+  md_document:
+    variant: markdown_github
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, echo = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "README-"
+)
+```
+
+# openeddy
+
+This package provides utilities for eddy covariance data handling, 
+quality checking (similar to Mauder et al., 2013), processing, summarising 
+and plotting. It aims to standardise the automated quality checking and make 
+data processing reproducible.
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+## basic example code
+```

README.md

@@ -0,0 +1,14 @@
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+openeddy
+========
+
+This package provides utilities for eddy covariance data handling, quality checking (similar to Mauder et al., 2013), processing, summarising and plotting. It aims to standardise the automated quality checking and make data processing reproducible.
+
+Example
+-------
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+## basic example code
+```