docs: publish typedocs (#176)

Updates project config to publish typedocs

.gitignore

@@ -1,44 +1,8 @@
-docs
-**/node_modules/
-**/*.log
-test/repo-tests*
-**/bundle.js
-.nyc_output
-
-# Logs
-logs
-*.log
-
-coverage
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-build
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
-
-lib
+build
 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
+.docs
+.coverage
+node_modules
 package-lock.json
+yarn.lock

README.md

@@ -1,10 +1,9 @@
 # @libp2p/mdns <!-- omit in toc -->
 
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-mdns.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-mdns)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-mdns/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-mdns/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-mdns/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Node.js libp2p mDNS discovery implementation for peer discovery
 
@@ -13,9 +12,9 @@
 - [Install](#install)
 - [Usage](#usage)
 - [MDNS messages](#mdns-messages)
-- [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribute](#contribute-1)
+- [Contribute](#contribute)
 
 ## Install
 
@@ -51,12 +50,16 @@ setTimeout(() => mdns.stop(), 20 * 1000)
 
 A query is sent to discover the IPFS nodes on the local network
 
-    { type: 'query',
-      questions: [ { name: 'ipfs.local', type: 'PTR' } ]
-    }
+```js
+{
+  type: 'query',
+  questions: [ { name: 'ipfs.local', type: 'PTR' } ]
+}
+```
 
 When a query is detected, each IPFS node sends an answer about itself
 
+```js
     [ { name: 'ipfs.local',
         type: 'PTR',
         class: 'IN',
@@ -86,13 +89,11 @@ When a query is detected, each IPFS node sends an answer about itself
         class: 'IN',
         ttl: 120,
         data: '::1' } ]
+```
 
-## Contribute
-
-The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
+## API Docs
 
-- Go through the modules and **check out existing issues**. This is especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
-- **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
+- <https://libp2p.github.io/js-libp2p-mdns>
 
 ## License