update doc links in README

CHANGELOG.md

@@ -14,3 +14,4 @@ All notable changes to `@homebridge/ciao` will be documented in this file. This
 - updated eslint rule
 - update to match renamed `latest` branch
 - regenerate docs
+- update doc links in README

README.md

@@ -84,34 +84,34 @@ service.destroy();
 
 ## Documentation 
 
-The full documentation can be found [here](https://developers.homebridge.io/ciao/globals.html).
+The full documentation can be found [here](https://developers.homebridge.io/ciao/modules.html).
 
 ### API overview
 
 This section links to the most important aspects of the documentation as used in the example above.
 
-First of all the [getResponder](https://developers.homebridge.io/ciao/globals.html#getresponder) function 
-should be used to get a reference to a [Responder](https://developers.homebridge.io/ciao/classes/responder.html) object.
-The function takes some optional [options](https://developers.homebridge.io/ciao/interfaces/mdnsserveroptions.html)
+First of all the [getResponder](https://developers.homebridge.io/ciao/functions/getResponder.html) function 
+should be used to get a reference to a [Responder](https://developers.homebridge.io/ciao/classes/Responder.html) object.
+The function takes some optional [options](https://developers.homebridge.io/ciao/interfaces/MDNSServerOptions.html)
 to configure the underlying mdns server.
 
-The [createService](https://developers.homebridge.io/ciao/classes/responder.html#createservice) method of the `Responder`
-object can now be used to create a new [CiaoService](https://developers.homebridge.io/ciao/classes/ciaoservice.html) 
-supplying the desired [configuration](https://developers.homebridge.io/ciao/interfaces/serviceoptions.html)
+The [createService](https://developers.homebridge.io/ciao/classes/Responder.html#createService) method of the `Responder`
+object can now be used to create a new [CiaoService](https://developers.homebridge.io/ciao/classes/CiaoService.html) 
+supplying the desired [configuration](https://developers.homebridge.io/ciao/interfaces/ServiceOptions.html)
 as the first parameter. You might have a look at the 
-_[restrictedAddresses](https://developers.homebridge.io/ciao/interfaces/serviceoptions.html#restrictedAddresses)_
-(and _[disableIpv6](https://developers.homebridge.io/ciao/interfaces/serviceoptions.html#disableIpv6)_) configuration
+_[restrictedAddresses](https://developers.homebridge.io/ciao/interfaces/ServiceOptions.html#restrictedAddresses)_
+(and _[disabledIpv6](https://developers.homebridge.io/ciao/interfaces/ServiceOptions.html#disabledIpv6)_) configuration
 if you don't want to advertise on all available addresses/network interfaces.
 
-The [advertise](https://developers.homebridge.io/ciao/classes/ciaoservice.html#advertise) method can now be called
+The [advertise](https://developers.homebridge.io/ciao/classes/CiaoService.html#advertise) method can now be called
 on the `service` object to start advertising the service on the network.
-An application should ideally listen to the [NAME_CHANGE](https://developers.homebridge.io/ciao/enums/serviceevent.html#name_changed)
+An application should ideally listen to the [NAME_CHANGED](https://developers.homebridge.io/ciao/enums/ServiceEvent.html#NAME_CHANGED)
 event, in oder to persist any changes happening to the service name resulting of the conflict resolution algorithm.
-The method [updateTxt](https://developers.homebridge.io/ciao/classes/ciaoservice.html#updatetxt) can be used
+The method [updateTxt](https://developers.homebridge.io/ciao/classes/CiaoService.html#updateTxt) can be used
 to update the contest of the txt exposed by the service.
 
 Any application SHOULD hook up a listener on events like SIGTERM or SIGINT and call the 
-[shutdown](https://developers.homebridge.io/ciao/classes/responder.html#shutdown) method of the responder object.
+[shutdown](https://developers.homebridge.io/ciao/classes/Responder.html#shutdown) method of the responder object.
 This will ensure, that goodbye packets are sent out on all connected network interfaces and all hosts
 on the network get instantly notified of the shutdown.
 Otherwise, stale data will remain in the caches of surrounding mdns browsers. 

docs/enums/Protocol.html

@@ -2,6 +2,6 @@
 <p>As of RFC 6763 7. TCP must be used for any applications using tcp.
  For applications using any other transport protocol UDP must be used.
  This applies to all other transport protocols like SCTP, DCCP, RTMFP, etc</p>
-</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/e9271a6bd2a6bd42dfbe2638cf8a6a08324d1b07/src/index.ts#L37">index.ts:37</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="Protocol.html#TCP" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>TCP</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/4bf5b6fe6e95a8e5dd93505c891f1c3e0ee8a46c/src/index.ts#L37">index.ts:37</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="Protocol.html#TCP" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>TCP</span></a>
 <a href="Protocol.html#UDP" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>UDP</span></a>
-</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="TCP" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>TCP</span><a href="#TCP" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">TCP</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;tcp&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/e9271a6bd2a6bd42dfbe2638cf8a6a08324d1b07/src/index.ts#L38">index.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="UDP" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>UDP</span><a href="#UDP" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">UDP</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;udp&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/e9271a6bd2a6bd42dfbe2638cf8a6a08324d1b07/src/index.ts#L39">index.ts:39</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#TCP" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>TCP</span></a><a href="#UDP" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>UDP</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@homebridge/ciao - v1.1.8</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
+</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="TCP" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>TCP</span><a href="#TCP" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">TCP</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;tcp&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/4bf5b6fe6e95a8e5dd93505c891f1c3e0ee8a46c/src/index.ts#L38">index.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="UDP" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>UDP</span><a href="#UDP" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">UDP</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;udp&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/4bf5b6fe6e95a8e5dd93505c891f1c3e0ee8a46c/src/index.ts#L39">index.ts:39</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#TCP" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>TCP</span></a><a href="#UDP" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>UDP</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@homebridge/ciao - v1.1.8</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>