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

libp2p / js-libp2p

The JavaScript Implementation of libp2p networking stack.

https://libp2p.io

Other

2.27k stars 435 forks source link

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

Closed MichaelJCole closed 4 months ago

MichaelJCole commented 4 months ago

Title

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

Description

Notes & open questions

Change checklist

[ ] I have performed a self-review of my own code
[ ] I have made corresponding changes to the documentation if necessary (this includes comments as well)
[ ] I have added tests that prove my fix is effective or that my feature works

achingbrain commented 4 months ago

Thanks for opening this.

Can you please run npm run docs in the root of the repo to update the README.md file, check the output of the generated docs for formatting and finally commit the updated README.md file.

You may need to run npm i && npm run build in the repo root first if you haven't already.

MichaelJCole commented 4 months ago

Ok, looks like the changes went through.

achingbrain commented 4 months ago

Thanks!