readme improvements

.gitignore

@@ -1,4 +1,3 @@
 bgdark.jpg
 bgwhite.jpg
 cover-ill.png
-template.pdf

README.md

@@ -1,27 +1,71 @@
 # TexNative Format
 
+Modern customizable Business Document Format for creating clean Reports,
+Quotations, Letters etc...
+
 ## Installing
 
 ```bash
 quarto use template wearetechnative/texnative
 ```
 
-This will install the extension and create an example qmd file that you can use as a starting place for your article.
+This will install the extension and create an example qmd file that you can use
+as a starting place for your article.
+
+## Features
+
+- modern business document
+- white and dark background
+- custom letterhead en frontpage images
+- filter to create modern looking tables
+
+![](Screenshot-TexNative.png)
+
+![](Screenshot-white.png)
 
 ## Using
 
-*TODO*: Describe how to use your format.
+Include this in your front matter.
 
-## Format Options
+```yaml
+format: texnative-pdf
+filters:
+  - texnative
+```
 
-*TODO*: If your format has options that can be set via document metadata, describe them.
+Have a look at the `temlate.qmd`. This generates [this pdf](template.pdf).
 
-## Example
+## Optional Frontmatter
 
-Here is the source code for a minimal sample document: [example.qmd](example.qmd).
+When set, these values are used in the cover page.
 
+```yaml
+subtitle: Agreement for a typical business case
+author: Jane Dean
+date: last-modified
+type: Report
+document_version: 1
+document_number: ABC013
+```
+
+## Format Options
+
+```yaml
+# DOCUMENT DEFAULT CONFIGURATION
+toc: true                                        # show table of contents
+toc-title: Contents                              # title of table of contents
+cover_page: true                                 # generate cover page
+letterhead: true                                 # use a letterhead background
+dark_background: true                            # use the dark bg or letterhead with white text
+page_numbers: true                               # show page numbers
+paragraph_numbers: true                          # show paragraph numbers before headers
+papersize: a4
+letterhead_img: bgwhite.jpg                      # path to background image
+letterhead_img_darkbg: bgdark.jpg                # path to background image for dark background
+cover_illustration_img: cover-ill.png            # path to cover page illustration image
+cover_illustration_img_darkbg: cover-ill.png     # path to cover page illustration image for dark background
+```
 
 ## Credits
 
 Illustration is created by Illustrations.co from the 'Life' collection.
-

template.qmd

@@ -3,18 +3,34 @@ title: "Some Agreement about stuff"
 subtitle: Agreement for a typical business case
 author: Jane Dean
 date: last-modified
+
+client:
+  name: Cool Customer Limited
+  short_name: Cool Customer
+  contact_person: Joe Johnson
+  address: Somewhereroad 1, Marslands
+
 format: texnative-pdf
 type: Report
 document_version: 1
 document_number: ABC013
-dark_background: true
 filters:
   - texnative
-client:
-  name: Cool Customer Limited
-  short_name: Cool Customer
-  contact_person: Joe Johnson
-  address: Somewhereroad 1, Marslands
+
+# DOCUMENT DEFAULT CONFIGURATION
+toc: true                                        # show table of contents
+toc-title: Contents                              # title of table of contents
+cover_page: true                                 # generate cover page
+letterhead: true                                 # use a letterhead background
+dark_background: true                            # use the dark bg or letterhead with white text
+page_numbers: true                               # show page numbers
+paragraph_numbers: true                          # show paragraph numbers before headers
+papersize: a4
+letterhead_img: bgwhite.jpg                      # path to background image
+letterhead_img_darkbg: bgdark.jpg                # path to background image for dark background
+cover_illustration_img: cover-ill.png            # path to cover page illustration image
+cover_illustration_img_darkbg: cover-ill.png     # path to cover page illustration image for dark background
+
 ---
 
 # Parties