Add simple documentation on how to install the tool and how to use the tool to the README. This is based on my limited experience with the tool, so it may contain some mistakes. I'd be happy to update this based on any suggestions. Maintainers: feel free to fix any mistakes in there yourselves.
The style of the docs were inspired by the docs for the errcheck tool. However, 1) it's much shorter as this option has fewer options, and 2) I tried to adhere to the existing style of the documentation.
Also, I'd be happy to update the docs when/if #6 and #43 get merged :smile:
Add simple documentation on how to install the tool and how to use the tool to the README. This is based on my limited experience with the tool, so it may contain some mistakes. I'd be happy to update this based on any suggestions. Maintainers: feel free to fix any mistakes in there yourselves.
The style of the docs were inspired by the docs for the errcheck tool. However, 1) it's much shorter as this option has fewer options, and 2) I tried to adhere to the existing style of the documentation.
Also, I'd be happy to update the docs when/if #6 and #43 get merged :smile: