fix: update project to build docs (#297)

.gitignore

@@ -1,14 +1,10 @@
 **/node_modules/
 **/*.log
-test/repo-tests*
-**/bundle.js
 
 # Logs
 logs
 *.log
 
-coverage
-
 # Runtime data
 pids
 *.pid
@@ -19,6 +15,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+.coverage
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
@@ -28,18 +25,15 @@ coverage
 
 build
 docs
+.docs
 
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
-lib
 dist
-test/test-data/go-ipfs-repo/LOCK
-test/test-data/go-ipfs-repo/LOG
-test/test-data/go-ipfs-repo/LOG.old
 
 # while testing npm5
 package-lock.json
 yarn.lock
-.nyc_output
+.nyc_output

README.md

@@ -15,6 +15,7 @@
 - [Usage](#usage)
 - [API](#api)
 - [Resolvers](#resolvers)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute)
 
@@ -106,6 +107,10 @@ The available resolvers are:
 
 A resolver receives a `Multiaddr` as a parameter and returns a `Promise<Array<string>>`.
 
+## API Docs
+
+- <https://multiformats.github.io/js-multiaddr>
+
 ## License
 
 Licensed under either of

package.json

@@ -155,7 +155,7 @@
     "dep-check": "aegir dep-check",
     "build": "aegir build",
     "test": "aegir test -f",
-    "test:chrome": "aegir test -t browser",
+    "test:chrome": "aegir test -t browser --cov",
     "test:chrome-webworker": "aegir test -t webworker",
     "test:firefox": "aegir test -t browser -- --browser firefox",
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
@@ -174,7 +174,7 @@
   },
   "devDependencies": {
     "@types/varint": "^6.0.0",
-    "aegir": "^37.6.2",
+    "aegir": "^37.7.2",
     "sinon": "^15.0.0",
     "util": "^0.12.3"
   },