Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

This repo is missing a README #2

Open
Mr0grog opened this issue Aug 23, 2018 · 0 comments
Open

This repo is missing a README #2

Mr0grog opened this issue Aug 23, 2018 · 0 comments

Comments

@Mr0grog
Copy link

Mr0grog commented Aug 23, 2018

As part of ipfs-inactive/docs#55, we’re trying to make sure every repo has a useful readme and description. go-metrics-prometheus has a description, but no README at all, so we should make sure we add one.

It doesn’t need to be too special, but we should at least explain:

  • Name
  • More detailed description that the GitHub description field (even if it’s only one short paragraph). Try and say how it fits into IPFS (e.g. go-ipfs relies on this module to send metrics when you configure xyz).
  • How to install (even if just go get xyz or git clone xyz)
  • Standard license text — you can pretty much just copy & paste.
  • Bonus points for a usage example if it’s easy to whip one up!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant