chore: update documentation

Author: vasco-santos

assets/anchor.js

@@ -6,7 +6,7 @@
 /* eslint-env amd, node */
 
 // https://github.com/umdjs/umd/blob/master/templates/returnExports.js
-(function(root, factory) {
+(function (root, factory) {
   'use strict';
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
@@ -21,7 +21,7 @@
     root.AnchorJS = factory();
     root.anchors = new root.AnchorJS();
   }
-})(this, function() {
+})(this, function () {
   'use strict';
   function AnchorJS(options) {
     this.options = options || {};
@@ -51,7 +51,7 @@
      * https://github.com/Modernizr/Modernizr/blob/da22eb27631fc4957f67607fe6042e85c0a84656/feature-detects/touchevents.js#L40
      * @returns {Boolean} - true if the current device supports touch.
      */
-    this.isTouchDevice = function() {
+    this.isTouchDevice = function () {
       return !!(
         'ontouchstart' in window ||
         (window.DocumentTouch && document instanceof DocumentTouch)
@@ -64,7 +64,7 @@
      *                                            to. Also accepts an array or nodeList containing the relavant elements.
      * @returns {this}                           - The AnchorJS object
      */
-    this.add = function(selector) {
+    this.add = function (selector) {
       var elements,
         elsWithIds,
         idList,
@@ -193,7 +193,7 @@
      *                                            OR a nodeList / array containing the DOM elements.
      * @returns {this}                           - The AnchorJS object
      */
-    this.remove = function(selector) {
+    this.remove = function (selector) {
       var index,
         domAnchor,
         elements = _getElements(selector);
@@ -216,7 +216,7 @@
     /**
      * Removes all anchorjs links. Mostly used for tests.
      */
-    this.removeAll = function() {
+    this.removeAll = function () {
       this.remove(this.elements);
     };
 
@@ -229,7 +229,7 @@
      * @param  {String} text - Any text. Usually pulled from the webpage element we are linking to.
      * @returns {String}      - hyphen-delimited text for use in IDs and URLs.
      */
-    this.urlify = function(text) {
+    this.urlify = function (text) {
       // Regex for finding the nonsafe URL characters (many need escaping): & +$,:;=?@"#{}|^~[`%!'<>]./()*\
       var nonsafeChars = /[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g,
         urlText;
@@ -260,7 +260,7 @@
      * @param    {HTMLElemnt}  el - a DOM node
      * @returns   {Boolean}     true/false
      */
-    this.hasAnchorJSLink = function(el) {
+    this.hasAnchorJSLink = function (el) {
       var hasLeftAnchor =
           el.firstChild &&
           (' ' + el.firstChild.className + ' ').indexOf(' anchorjs-link ') > -1,

assets/site.js

@@ -7,7 +7,7 @@ anchors.add('h3');
 // Filter UI
 var tocElements = document.getElementById('toc').getElementsByTagName('li');
 
-document.getElementById('filter-input').addEventListener('keyup', function(e) {
+document.getElementById('filter-input').addEventListener('keyup', function (e) {
   var i, element, children;
 
   // enter key
@@ -22,14 +22,14 @@ document.getElementById('filter-input').addEventListener('keyup', function(e) {
     }
   }
 
-  var match = function() {
+  var match = function () {
     return true;
   };
 
   var value = this.value.toLowerCase();
 
   if (!value.match(/^\s*$/)) {
-    match = function(element) {
+    match = function (element) {
       var html = element.firstChild.innerHTML;
       return html && html.toLowerCase().indexOf(value) !== -1;
     };
@@ -114,12 +114,12 @@ var cw_without_sb = split_left.clientWidth;
 split_left.style.overflow = '';
 
 Split(['#split-left', '#split-right'], {
-  elementStyle: function(dimension, size, gutterSize) {
+  elementStyle: function (dimension, size, gutterSize) {
     return {
       'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)'
     };
   },
-  gutterStyle: function(dimension, gutterSize) {
+  gutterStyle: function (dimension, gutterSize) {
     return {
       'flex-basis': gutterSize + 'px'
     };
@@ -152,9 +152,9 @@ function loadState(ev) {
   }
 }
 
-window.addEventListener('load', function() {
+window.addEventListener('load', function () {
   // Restore after Firefox scrolls to hash.
-  setTimeout(function() {
+  setTimeout(function () {
     loadState();
     // Update with initial scroll position.
     updateState();

index.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset='utf-8'>
-  <title>ipfs-http-response 0.5.0 | Documentation</title>
+  <title>ipfs-http-response 0.5.1 | Documentation</title>
   <meta name='description' content='Creates an HTTP response from an IPFS Hash'>
   <meta name='viewport' content='width=device-width,initial-scale=1'>
   <link href='assets/bass.css' rel='stylesheet'>
@@ -15,11 +15,14 @@
       <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
         <div class='py1 px2'>
           <h3 class='mb0 no-anchor'>ipfs-http-response</h3>
-          <div class='mb1'><code>0.5.0</code></div>
+          <div class='mb1'><code>0.5.1</code></div>
           <input
             placeholder='Filter'
             id='filter-input'
             class='col12 block input'
+            spellcheck='false'
+            autocapitalize='off'
+            autocorrect='off'
             type='text' />
           <div id='toc'>
             <ul class='list-reset h5 py1-ul'>
@@ -58,10 +61,10 @@ <h2>Download</h2>
 <p>You can then <code>require()</code> ipfs-http-response as normal:</p>
 <pre class='hljs'><span class="hljs-keyword">const</span> ipfsHttpResponse = <span class="hljs-built_in">require</span>(<span class="hljs-string">'ipfs-http-response'</span>)</pre>
 <h2>In the Browser</h2>
-<p>Ipfs-http-response should work in any ES2015 environment out of the box.</p>
+<p><code>ipfs-http-response</code> should work in any ECMAScript 2018 environment out of the box.</p>
 <p>Usage:</p>
 <pre class='hljs'><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text/javascript"</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"index.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></pre>
-<p>The portable versions of ipfs-http-response, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Ipfs-http-response can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
+<p>The portable versions of <code>ipfs-http-response</code>, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. <code>ipfs-http-response</code> can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
 <ul>
 <li><a href="https://unpkg.com/ipfs-http-response/dist/index.min.js">https://unpkg.com/ipfs-http-response/dist/index.min.js</a></li>
 <li><a href="https://unpkg.com/ipfs-http-response/dist/index.js">https://unpkg.com/ipfs-http-response/dist/index.js</a></li>