Browse Source

build docs

pull/14/head
Brett Langdon 11 years ago
parent
commit
0a06e34c52
1 changed files with 38 additions and 0 deletions
  1. +38
    -0
      index.html

+ 38
- 0
index.html View File

@ -24,6 +24,8 @@ document.addEventListener("DOMContentLoaded", function(){hljs.initHighlightingOn
</li>
<li role=""><a href="#tag">tag</a>
</li>
<li role=""><a href="#user">user</a>
</li>
<li role=""><a href="#client">client</a>
</li>
<li role=""><a href="#dogapi">dogapi</a>
@ -517,6 +519,41 @@ dogapi.tag.delete(&quot;host.name&quot;, function(err, results){
</div>
</div>
</section>
<section id="user" class="col-sm-12">
<div class="row">
<h2 class="bg-primary" style="text-indent:1rem">user</h2></div>
<ul class="nav nav-pills">
<li role"presentation"><a href="#user-invite">invite</a></li>
</ul>
<div class="function row" id="user-invite">
<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">invite(emails, callback)</h3>
<div class="col-md-6">
<p>invite users via e-mail</p>
<h4>Parameters:</h4>
<dl>
<dt>emails</dt>
<dd><p>an array of email addresses to send invites to</p>
</dd>
<dt>callback</dt>
<dd><p>function(err, res)</p>
</dd>
</dl>
</div>
<div class="col-md-6">
<pre><code class="lang-javascript">var dogapi = require(&quot;dogapi&quot;);
var options = {
api_key: &quot;api_key&quot;,
app_key: &quot;app_key&quot;
};
dogapi.initialize(options);
var emails = [&quot;me@domain.com&quot;, &quot;you@domain.com&quot;];
dogapi.user.invite(emails, fuction(err, res){
console.dir(res):
});
</code></pre>
</div>
</div>
</section>
<section id="client" class="col-sm-12">
<div class="row">
<h2 class="bg-primary" style="text-indent:1rem">client</h2></div>
@ -577,6 +614,7 @@ dogapi.client.request(&quot;GET&quot;, &quot;/url/path&quot;, {}, function(err,
<div class="function row" id="dogapi-initialize">
<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">initialize(options)</h3>
<div class="col-md-6">
<p>configure the dogapi client with your app/api keys</p>
<h4>Parameters:</h4>
<dl>
<dt>options</dt>


Loading…
Cancel
Save