docs(autonat): Add documentation on where to get results of service (#…

…2451)

Document AutoNAT service - how it works and where results can be found.

---------

Co-authored-by: Michael Cole <gitlab@michaelcole.com>

packages/protocol-autonat/README.md

@@ -24,8 +24,20 @@ repo and examine the changes made.
 
 -->
 
-Use the `autoNATService` function to add support for the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
-to libp2p.
+The AutoNAT service uses the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/).
+The service confirms addresses are dialable by remote peers, and updates the list it advertises.
+
+The service dials randomly selected peers with a request to verify it's external addresses.
+The request includes a list of public multiaddrs (addressManager.getObservedAddrs()).
+The remote peers dial that list and respond with the results.
+
+The AutoNAT service uses those responses to either:
+
+- addressManager.confirmObservedAddr(addr)
+- addressManager.removeObservedAddr(addr)
+
+The result list of candidates and confirmed addresses can be found
+at addressManager.getObservedAddrs()
 
 ## Example
 

packages/protocol-autonat/src/index.ts

@@ -1,8 +1,19 @@
 /**
  * @packageDocumentation
  *
- * Use the `autoNATService` function to add support for the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
- * to libp2p.
+ * The AutoNAT service uses the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/).
+ * The service confirms addresses are dialable by remote peers, and updates the list it advertises.
+ *
+ * The service dials randomly selected peers with a request to verify it's external addresses.
+ * The request includes a list of public multiaddrs (addressManager.getObservedAddrs()).
+ * The remote peers dial that list and respond with the results.
+ *
+ * The AutoNAT service uses those responses to either:
+ * - addressManager.confirmObservedAddr(addr)
+ * - addressManager.removeObservedAddr(addr)
+ *
+ * The result list of candidates and confirmed addresses can be found
+ * at addressManager.getObservedAddrs()
  *
  * @example
  *