Updated Readme

This commit is contained in:
Craig Yamato
2018-09-25 18:23:58 +00:00
parent b6a4870f1b
commit 00b72a3f57
28 changed files with 8448 additions and 253 deletions

View File

@ -54,7 +54,14 @@
<div class="container-overview">
<div class="description">The SyslogPro class for sending syslog messages</div>
<div class="description">The SyslogPro module for sending syslog messages
Most APIs will return a promise. These APIs can be used using
`then(...)/catch(...)`
Syslog formating classes can be used as input into a Syslog class to be used
simultatniusly to the same Syslog server. The Syslog Class with a configured
Syslog server target can also be used as the input into each of the formating
classes so that they may run independtly.</div>
@ -74,13 +81,10 @@
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li>0.0.0</li></ul></dd>
<dd class="tag-version"><ul class="dummy"><li>0.1.0</li></ul></dd>
<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li>0.0.0</li></ul></dd>
@ -203,7 +207,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line29">line 29</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line35">line 35</a>
</li></ul></dd>
@ -391,7 +395,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>