Updates

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: posterdown
 Title: Generate PDF Conference Posters Using R Markdown
-Version: 0.1.2.9000
+Version: 0.1.3
 Authors@R: 
     c(person(given = "Brent",
              family = "Thorne",
@@ -17,7 +17,7 @@ Authors@R:
              family = "Johnston",
              role = "ctb"))
 Description: Posterdown expands on RMarkdown to generate
-    PDF and HTML conference posters.
+    HTML and PDF conference posters.
 License: MIT + file LICENSE
 URL: https://github.com/brentthorne/posterdown
 BugReports: https://github.com/brentthorne/posterdown/issues
@@ -28,5 +28,6 @@ Imports:
     yaml
 Encoding: UTF-8
 LazyData: true
+VignetteBuilder: knitr
 RoxygenNote: 6.1.1
 Roxygen: list(markdown = TRUE)

inst/rmarkdown/templates/posterdown_betterland/template.yaml

@@ -1,4 +1,4 @@
 name: Posterdown Betterland
 description: >
- Template for creating R Markdown based PDF via HTML, CSS and the Better Poster Style
+ Template for creating R Markdown based PDF posters via HTML, CSS and the Better Poster Style
 create_dir: false

inst/rmarkdown/templates/posterdown_betterport/template.yaml

@@ -1,4 +1,4 @@
 name: Posterdown HTML Betterport
 description: >
- Template for creating R Markdown based PDF via HTML, CSS and the Better Poster Style
+ Template for creating R Markdown based PDF posters via HTML, CSS and the Better Poster Style
 create_dir: false

vignettes/posterdown.Rmd

@@ -0,0 +1,31 @@
+---
+title: "Generating reproducible conference posters using posterdown and rmarkdown"
+author: "Brent Thorne"
+date: "`r Sys.Date()`"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{posterdown}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r setup, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+This document is intended to be an introduction to using the {posterdown} package in order to generate a reproducible conference poster. The intent of this package is to allow for simple, clean, and production ready templates that can be customized as needed.
+
+## Getting Started
+
+To generate a blank poster document add the following to your `.Rmd` file:
+
+```markdown
+---
+output:
+  posterdown::posterdown_html
+---
+
+```