documentation (still in WIP)

README.md

@@ -20,15 +20,21 @@ It can be used with version 5.1.1 and later of NLog
 
     `Install-Package NLog.Target.Bugsnag`
 
-2) Use the target type `"Bugsnag, NLog.Targets.Bugsnag"` in your nlog.config including apiKey and releaseStage
+2) Use the target type `"Bugsnag, NLog.Targets.Bugsnag"` in your nlog.config including apiKey and releaseStage (see [Configuration](/docs/configuration.md) page for all parameters). Best with [AsyncWrappers](https://github.com/NLog/NLog/wiki/AsyncWrapper-target)
 
     ```xml
-          <target name="bugsnag" xsi:type="Bugsnag, NLog.Targets.Bugsnag"
-                  apikey="your-busgnag-api-key-goes-here"
-                  releaseStage="development|production"
-          </target>
+    <target name="bugsnagAsync" xsi:type="AsyncWrapper">
+      <target xsi:type="Bugsnag, NLog.Targets.Bugsnag"
+              name="bugsnag" 
+              apikey="your-busgnag-api-key-goes-here"
+              releaseStage="development|production"
+      </target>
+    </target>
+    <rules>
+      <logger minLevel="Error" writeTo="bugsnagAsync" />
+    </rules>
     ```
-
+     
 ### Support
 
 NLog Bugsnag is open source software maintained by voluntary contributors in their spare time and on a best effort basis.

docs/configuration.md

@@ -0,0 +1,56 @@
+## Configuration Syntax
+```xml
+<targets>
+  <target name="bugsnagAsync" xsi:type="AsyncWrapper">
+    <target xsi:type="Bugsnag, NLog.Targets.Bugsnag"
+            name="String" 
+            apikey="String"
+            releaseStage="String"
+            context="Layout"
+            errorClass="Layout">
+      <app appType="Layout"
+           version="Layout">
+        <assembly name="String" /><!-- repeated -->
+      </app>
+      <request include="Boolean">
+        <clientIp include="Boolean" layout="Layout" />
+        <headers include="Boolean" layout="Layout" />
+        <httpMethod include="Boolean" />
+        <referer include="Boolean" />
+        <url include="Boolean" />
+      </request>
+    </target>
+  </target>
+</targets>
+```
+## Target Parameters
+* _name_ - Name of the target. [String] 
+* _apiKey_ - [Required] The "Notifier API key"  generated by Bugsnag when creating the project.
+* _releaseStage_ - [Required]
+* _context_ - [Optional]
+* _errorClass_ - [Optional]
+
+## App Parameters
+* _appType_ - [Optional]
+* _version_ - [Optional]
+* _assembly_ - [Optional] A collection of assemblies name to include with their version.
+    * _name_ - 
+
+## Request Parameters
+* _include_ - 
+* _clientIp_ -
+    * _include_ -
+    * _layout_ -
+* _headers_ -
+    * _include_ -
+    * _layout_ -
+* _httpMethod_ -
+    * _include_ -
+    * _layout_ -
+* _referer_ -
+    * _include_ -
+    * _layout_ -
+* _url_ -
+    * _include_ -
+    * _layout_ -
+