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

Already on GitHub? Sign in to your account

Improve documentation #196

Closed
mrtazz opened this Issue Nov 25, 2012 · 1 comment

Comments

Projects
None yet
1 participant
Owner

mrtazz commented Nov 25, 2012

The README is not very clear at the moment. There is too much going on in there. It takes too much time to find anything.

Here's what I would like to have in the README:

  • brief description of what StatsD does
  • link to further documentation
  • how to install it
  • brief usage overview
  • how to submit bugs
  • how to submit patches

Anything more complicated than that should be moved to documentation of some sorts. Either in form of a wiki or a separate documentation folder. Not 100% sure on that yet. Suggestions are highly welcome.

@ghost ghost assigned mrtazz Nov 25, 2012

Owner

mrtazz commented Apr 8, 2013

Fixed since we moved documentation to https://github.com/etsy/statsd/tree/master/docs

@mrtazz mrtazz closed this Apr 8, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment