Skip to content

Commit 3698b47

Browse files
author
marcelorl
committed
docs: updated
1 parent d4332cd commit 3698b47

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ $ npm test
4040

4141
## Documentation
4242

43+
You have a look at the documentation [here](https://joshghent.github.io/query-stringifier/).
44+
4345
If you ever edit the documentation and wants to generate a new version of it just run the command:
4446

4547
```

docs/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ <h2>Install</h2><pre class="prettyprint source lang-bash"><code>$ npm install qu
7777

7878
// Parse query strings into objects
7979
qs.parse('?food=pizza&bar=chocolate');
80-
// { food: pizza, bar: chocolate }</code></pre><h2>Tests</h2><pre class="prettyprint source"><code>$ npm test</code></pre><h2>Documentation</h2><p>If you ever edit the documentation and wants to generate a new version of it just run the command:</p>
80+
// { food: pizza, bar: chocolate }</code></pre><h2>Tests</h2><pre class="prettyprint source"><code>$ npm test</code></pre><h2>Documentation</h2><p>You have a look at the documentation <a href="https://joshghent.github.io/query-stringifier/">here</a>.</p>
81+
<p>If you ever edit the documentation and wants to generate a new version of it just run the command:</p>
8182
<pre class="prettyprint source"><code>$ npm run docs</code></pre><p>Commit your changes and push them to master. Github pages will update the page automatically.</p>
8283
<h2>Issues?</h2><p>Go <a href="https://github.com/joshghent/query-stringifier/issues">here</a></p>
8384
<h2>Contributing</h2><p>Insterested to help? Just follow our <a href="https://github.com/joshghent/query-stringifier/blob/master/CONTRIBUTING.md">Contribution Guide</a>.</p></article>

0 commit comments

Comments
 (0)