update docs for release

CHANGELOG.md

@@ -1,4 +1,6 @@
 # Unreleased
+
+# 1.5.0
 * Rework logging to be less noisy and more organized.
    * Use Winston
    * log warning and worse to the console

docs/emojme-download.js.html

@@ -114,7 +114,8 @@ <h1 class="page-title">
  * @param {boolean} [options.saveAll] if `true`, download all emoji on slack instance from all users to disk in a single location.
  * @param {boolean} [options.saveAllByUser] if `true`, download all emoji on slack instance from all users to disk, organized into directories by user.
  * @param {boolean} [options.bustCache] if `true`, ignore any adminList younger than 24 hours and repull slack instance's existing emoji. Can be useful for making `options.avoidCollisions` more accurate
- * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use
+ * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files
+ * @param {boolean} [options.verbose] if `true`, all messages will be written to stdout in addition to combined log file.
  *
  * @returns {Promise&lt;downloadResponseObject>} downloadResponseObject result object
  *

docs/emojme-sync.js.html

@@ -119,7 +119,8 @@ <h1 class="page-title">
  * @param {string|string[]} [options.dstSubdomains] slack instances in which all source emoji will be deposited. None of `dstSubdomain`'s emoji will end up in `srcSubdomain`
  * @param {string|string[]} [options.dstTokens] user tokens for the slack instances where emoji will be deposited
  * @param {boolean} [options.bustCache] if `true`, ignore any adminList younger than 24 hours and repull slack instance's existing emoji. Can be useful for making `options.avoidCollisions` more accurate
- * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use
+ * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files
+ * @param {boolean} [options.verbose] if `true`, all messages will be written to stdout in addition to combined log file.
  *
  * @returns {Promise&lt;syncResponseObject>} syncResponseObject result object
  *

docs/emojme-upload.js.html

@@ -170,7 +170,8 @@ <h1 class="page-title">
  * @param {boolean} [options.avoidCollisions] if `true`, emoji being added will be renamed to not collide with existing emoji. See {@link lib/util/helpers.avoidCollisions} for logic and details // TODO: fix this link, maybe link to tests which has better examples
  * @param {string} [options.prefix] string to prefix all emoji being uploaded
  * @param {boolean} [options.bustCache] if `true`, ignore any adminList younger than 24 hours and repull slack instance's existing emoji. Can be useful for making `options.avoidCollisions` more accurate
- * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use
+ * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files
+ * @param {boolean} [options.verbose] if `true`, all messages will be written to stdout in addition to combined log file.
  *
  * @returns {Promise&lt;uploadResponseObject>} uploadResponseObject result object
  *

docs/emojme-user-stats.js.html

@@ -123,7 +123,8 @@ <h1 class="page-title">
  * @param {string|string[]} [options.user] user name or array of user names you would like to retrieve user statistics on. If specified, ignores `top`
  * @param {Number} [options.top] count of top n emoji contriubtors you would like to retrieve user statistics on
  * @param {boolean} [options.bustCache] if `true`, ignore any adminList younger than 24 hours and repull slack instance's existing emoji. Can be useful for making `options.avoidCollisions` more accurate
- * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use
+ * @param {boolean} [options.output] if `false`, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files
+ * @param {boolean} [options.verbose] if `true`, all messages will be written to stdout in addition to combined log file.
  *
  * @returns {Promise&lt;userStatsResponseObject>} userStatsResponseObject result object
  *

docs/module-download.html

@@ -479,7 +479,46 @@ <h6>Properties</h6>
 
 
         <td class="description last">
-          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use</p>
+          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files</p>
+
+        </td>
+      </tr>
+
+
+      <tr>
+
+          <td class="name"><code>verbose</code></td>
+
+
+        <td class="type">
+
+
+    <span class="param-type">
+      boolean
+    </span>
+
+
+
+
+
+        </td>
+
+
+          <td class="attributes">
+
+              &lt;optional><br>
+
+
+
+
+
+          </td>
+
+
+
+
+        <td class="description last">
+          <p>if <code>true</code>, all messages will be written to stdout in addition to combined log file.</p>
 
         </td>
       </tr>
@@ -531,7 +570,7 @@ <h6>Properties</h6>
     <dd class="tag-source">
       <ul class="dummy">
         <li>
-          <a href="emojme-download.js.html">emojme-download.js</a>, <a href="emojme-download.js.html#line57">line 57</a>
+          <a href="emojme-download.js.html">emojme-download.js</a>, <a href="emojme-download.js.html#line58">line 58</a>
         </li>
       </ul>
     </dd>

docs/module-sync.html

@@ -549,7 +549,46 @@ <h6>Properties</h6>
 
 
         <td class="description last">
-          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use</p>
+          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files</p>
+
+        </td>
+      </tr>
+
+
+      <tr>
+
+          <td class="name"><code>verbose</code></td>
+
+
+        <td class="type">
+
+
+    <span class="param-type">
+      boolean
+    </span>
+
+
+
+
+
+        </td>
+
+
+          <td class="attributes">
+
+              &lt;optional><br>
+
+
+
+
+
+          </td>
+
+
+
+
+        <td class="description last">
+          <p>if <code>true</code>, all messages will be written to stdout in addition to combined log file.</p>
 
         </td>
       </tr>
@@ -601,7 +640,7 @@ <h6>Properties</h6>
     <dd class="tag-source">
       <ul class="dummy">
         <li>
-          <a href="emojme-sync.js.html">emojme-sync.js</a>, <a href="emojme-sync.js.html#line62">line 62</a>
+          <a href="emojme-sync.js.html">emojme-sync.js</a>, <a href="emojme-sync.js.html#line63">line 63</a>
         </li>
       </ul>
     </dd>

docs/module-upload.html

@@ -477,7 +477,46 @@ <h6>Properties</h6>
 
 
         <td class="description last">
-          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use</p>
+          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files</p>
+
+        </td>
+      </tr>
+
+
+      <tr>
+
+          <td class="name"><code>verbose</code></td>
+
+
+        <td class="type">
+
+
+    <span class="param-type">
+      boolean
+    </span>
+
+
+
+
+
+        </td>
+
+
+          <td class="attributes">
+
+              &lt;optional><br>
+
+
+
+
+
+          </td>
+
+
+
+
+        <td class="description last">
+          <p>if <code>true</code>, all messages will be written to stdout in addition to combined log file.</p>
 
         </td>
       </tr>
@@ -529,7 +568,7 @@ <h6>Properties</h6>
     <dd class="tag-source">
       <ul class="dummy">
         <li>
-          <a href="emojme-upload.js.html">emojme-upload.js</a>, <a href="emojme-upload.js.html#line109">line 109</a>
+          <a href="emojme-upload.js.html">emojme-upload.js</a>, <a href="emojme-upload.js.html#line110">line 110</a>
         </li>
       </ul>
     </dd>

docs/module-userStats.html

@@ -440,7 +440,46 @@ <h6>Properties</h6>
 
 
         <td class="description last">
-          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use</p>
+          <p>if <code>false</code>, no files will be written during execution. Prevents saving of adminList for future use, as well as the writing of log files</p>
+
+        </td>
+      </tr>
+
+
+      <tr>
+
+          <td class="name"><code>verbose</code></td>
+
+
+        <td class="type">
+
+
+    <span class="param-type">
+      boolean
+    </span>
+
+
+
+
+
+        </td>
+
+
+          <td class="attributes">
+
+              &lt;optional><br>
+
+
+
+
+
+          </td>
+
+
+
+
+        <td class="description last">
+          <p>if <code>true</code>, all messages will be written to stdout in addition to combined log file.</p>
 
         </td>
       </tr>
@@ -492,7 +531,7 @@ <h6>Properties</h6>
     <dd class="tag-source">
       <ul class="dummy">
         <li>
-          <a href="emojme-user-stats.js.html">emojme-user-stats.js</a>, <a href="emojme-user-stats.js.html#line72">line 72</a>
+          <a href="emojme-user-stats.js.html">emojme-user-stats.js</a>, <a href="emojme-user-stats.js.html#line73">line 73</a>
         </li>
       </ul>
     </dd>

package.json

@@ -1,14 +1,14 @@
 {
   "name": "emojme",
   "description": "The Emojartist's toolbox for spreading their work across the slackosphere",
+  "version": "1.5.0",
   "keywords": [
     "emoji",
     "slack",
     "sync",
     "download",
     "upload"
   ],
-  "version": "1.4.0",
   "author": "Jack Ellenberger <jellenberger@uchicago.edu>",
   "repository": {
     "type": "git",