Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
auralia committed Nov 15, 2016
1 parent 3945054 commit e99eb09
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ You can also build nsapi from source using Gulp. There are two main targets:
`prod` and `dev`. The only difference between them is that `dev` includes
source maps. There is also a `docs` target to generate documentation.

Consult the documentation for more information on API structure and methods.
Consult [the documentation](https://auralia.github.io/node-nsapi/) for more
information on API structure and methods.

## Examples ##

Expand Down
5 changes: 3 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ <h2 id="usage">Usage</h2>
<p>You can also build nsapi from source using Gulp. There are two main targets:
<code>prod</code> and <code>dev</code>. The only difference between them is that <code>dev</code> includes
source maps. There is also a <code>docs</code> target to generate documentation.</p>
<p>Consult the documentation for more information on API structure and methods.</p>
<p>Consult <a href="https://auralia.github.io/node-nsapi/">the documentation</a> for more
information on API structure and methods.</p>
<h2 id="examples">Examples</h2>
<p>The following is a simple example that retrieves a nation&#39;s full name and prints
it to the console.</p>
Expand All @@ -100,7 +101,7 @@ <h2 id="examples">Examples</h2>
api.cleanup();
});
</code></pre>
<p>For additional examples, consult the example.js file.</p>
<p>For additional examples, consult the examples/example.js file.</p>
<h2 id="license">License</h2>
<p>nsapi is licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.</p>
</div>
Expand Down

0 comments on commit e99eb09

Please sign in to comment.