Build docs

tiaanduplessis · Mar 29, 2018 · 68c5297 · 68c5297
1 parent 5d21f6a
commit 68c5297
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -81,12 +81,18 @@ client.getGlobal().then(console.log).catch(console.error)
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
+#### Table of Contents
+
+-   [getTicker](#getticker)
+-   [getGlobal](#getglobal)
+
 ### getTicker
 
 Get ticker information
 
 **Parameters**
 
+-   `args`   (optional, default `{}`)
 -   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options for the request:
     -   `options.start` **Int?** Return results from rank start + 1 and above
     -   `options.limit` **Int?** Only returns limit number of results

diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset='utf-8' />
-  <title>coinmarketcap-api 1.0.0 | Documentation</title>
+  <title>coinmarketcap-api 1.0.2 | Documentation</title>
   <meta name='viewport' content='width=device-width,initial-scale=1'>
   <link href='assets/bass.css' type='text/css' rel='stylesheet' />
   <link href='assets/style.css' type='text/css' rel='stylesheet' />
@@ -14,7 +14,7 @@
       <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
         <div class='py1 px2'>
           <h3 class='mb0 no-anchor'>coinmarketcap-api</h3>
-          <div class='mb1'><code>1.0.0</code></div>
+          <div class='mb1'><code>1.0.2</code></div>
           <input
             placeholder='Filter'
             id='filter-input'
@@ -69,7 +69,7 @@ <h3 class='fl m0' id='getticker'>
   <p>Get ticker information</p>
 
 
-  <div class='pre p1 fill-light mt0'>getTicker(options: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?)</div>
+  <div class='pre p1 fill-light mt0'>getTicker(args: any, options: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?)</div>
 
 
 
@@ -84,6 +84,15 @@ <h3 class='fl m0' id='getticker'>
     <div class='py1 quiet mt1 prose-big'>Parameters</div>
     <div class='prose'>
 
+        <div class='space-bottom0'>
+          <div>
+            <span class='code bold'>args</span> <code class='quiet'>(any
+            = <code>{}</code>)</code>
+
+          </div>
+
+        </div>
+
         <div class='space-bottom0'>
           <div>
             <span class='code bold'>options</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?)</code>