Updates to README - Githubissues

intelsdi-x / snap-plugin-collector-ethtool

Collects ethtool interface stats & registry dump

http://snap-telemetry.io/

Apache License 2.0

0 stars 13 forks source link

Updates to README #9

Closed mbbroberg closed 8 years ago

mbbroberg commented 8 years ago

This repo is one of the best we have in the snap framework when it comes to documentation. I'd like to get a few edits in there and then use it as a template going forward. Here's what was edited:

Clarifying installation section - we want to guide people to download from builds, so I thought to show a gif of it and reorganize that section
Separated out the build process vs use, since we distributed sweet sweet binaries
Minor typos

Feedback welcome!

mbbroberg commented 8 years ago

Docs update but welcome a review from @intelsdi-x/plugin-maintainers :+1:

thomastaylor312 commented 8 years ago

LGTM

mbbroberg commented 8 years ago

Thanks @thomastaylor312 - merging.