readme updates

.Rbuildignore

@@ -3,3 +3,4 @@
 ^README\.Rmd$
 ^README-.*\.png$
 ^\.travis\.yml$
+^\.Rhistory$

README.Rmd

@@ -21,8 +21,9 @@ knitr::opts_chunk$set(
 [![Travis-CI Build Status](https://travis-ci.org/evanodell/nomisr.svg?branch=master)](https://travis-ci.org/evanodell/nomisr)
 [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/evanodell/nomisr?branch=master&svg=true)](https://ci.appveyor.com/project/evanodell/nomisr)
 [![Coverage Status](https://img.shields.io/codecov/c/github/evanodell/nomisr/master.svg)](https://codecov.io/github/evanodell/nomisr?branch=master)
+[![DOI](https://zenodo.org/badge/118144805.svg)](https://zenodo.org/badge/latestdoi/118144805)
 
-`nomisr` is for accessing [nomis](https://www.nomisweb.co.uk/) data on UK labour market statistics with R. 
+`nomisr` is for accessing [nomis](https://www.nomisweb.co.uk/) data with R. nomis contains labour market statistics, including data on benefits, and census data.
 
 ## Installation
 
@@ -32,12 +33,15 @@ You can install nomisr from github with:
 # install.packages("devtools")
 devtools::install_github("evanodell/nomisr")
 ```
-<!--
-## Example
 
-This is a basic example which shows you how to solve a common problem:
+## Using `nomisr`
+
+The example below gets the latest data on Jobseeker's Allowance with rates and proportions, on a national level, with all male claimants and workforce 
 
 ```{r example}
-## basic example code
+ library(nomisr)
+ z <- nomis_get_data(id="NM_1_1", time="latest", geography="TYPE499", measures=c(20100, 20201), sex=5)
 ```
--->
+
+There is a lot of data available through nomis, and there are some limits to the amount of data that can be retrieved within a certain period of time, although those are not published. For more details, see the [full API documentation](https://www.nomisweb.co.uk/api/v01/help) from nomis.
+

README.md

@@ -1,14 +1,27 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
-nomisr
-======
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/nomisr)](https://cran.r-project.org/package=nomisr) [![GitHub tag](https://img.shields.io/github/tag/evanodell/nomisr.svg)](https://github.com/evanodell/nomisr) [![](https://cranlogs.r-pkg.org/badges/grand-total/nomisr)](https://dgrtwo.shinyapps.io/cranview/) [![Travis-CI Build Status](https://travis-ci.org/evanodell/nomisr.svg?branch=master)](https://travis-ci.org/evanodell/nomisr) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/evanodell/nomisr?branch=master&svg=true)](https://ci.appveyor.com/project/evanodell/nomisr) [![Coverage Status](https://img.shields.io/codecov/c/github/evanodell/nomisr/master.svg)](https://codecov.io/github/evanodell/nomisr?branch=master)
+# nomisr
 
-`nomisr` is for accessing [nomis](https://www.nomisweb.co.uk/) data on UK labour market statistics with R.
+[![License:
+MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/nomisr)](https://cran.r-project.org/package=nomisr)
+[![GitHub
+tag](https://img.shields.io/github/tag/evanodell/nomisr.svg)](https://github.com/evanodell/nomisr)
+[![](https://cranlogs.r-pkg.org/badges/grand-total/nomisr)](https://dgrtwo.shinyapps.io/cranview/)
+[![Travis-CI Build
+Status](https://travis-ci.org/evanodell/nomisr.svg?branch=master)](https://travis-ci.org/evanodell/nomisr)
+[![AppVeyor Build
+Status](https://ci.appveyor.com/api/projects/status/github/evanodell/nomisr?branch=master&svg=true)](https://ci.appveyor.com/project/evanodell/nomisr)
+[![Coverage
+Status](https://img.shields.io/codecov/c/github/evanodell/nomisr/master.svg)](https://codecov.io/github/evanodell/nomisr?branch=master)
+[![DOI](https://zenodo.org/badge/118144805.svg)](https://zenodo.org/badge/latestdoi/118144805)
 
-Installation
-------------
+`nomisr` is for accessing [nomis](https://www.nomisweb.co.uk/) data with
+R. nomis contains labour market statistics, including data on benefits,
+and census data.
+
+## Installation
 
 You can install nomisr from github with:
 
@@ -17,13 +30,19 @@ You can install nomisr from github with:
 devtools::install_github("evanodell/nomisr")
 ```
 
-<!--
-## Example
-
-This is a basic example which shows you how to solve a common problem:
+## Using `nomisr`
 
+The example below gets the latest data on Jobseeker’s Allowance with
+rates and proportions, on a national level, with all male claimants and
+workforce
 
-```r
-## basic example code
+``` r
+ library(nomisr)
+ z <- nomis_get_data(id="NM_1_1", time="latest", geography="TYPE499", measures=c(20100, 20201), sex=5)
 ```
--->
+
+There is a lot of data available through nomis, and there are some
+limits to the amount of data that can be retrieved within a certain
+period of time, although those are not published. For more details, see
+the [full API documentation](https://www.nomisweb.co.uk/api/v01/help)
+from nomis.