donnemartin/gitsome

Prioritize documentation

Opened this issue · 2 comments

iamnewton commented

I think the work you've done on this is amazing. Seems like a great project, but your README is a bit bloated and hard to decipher. Might I suggest you condense it down into a set of readable chunks and maybe link off to the wiki for the more detailed bits.

Its only my opinion, but I find that answering the following questions, in order, helps to simplify docs.

  • who? - who wrote the package
  • what? - what is the package? i.e. description of what the package does
  • where? - where the package can be found? i.e. installation via the various package managers
  • when? - current version
  • why? - what makes this package unique, why should i install this
  • how? - how can i help out if i want to

This is just food for thought. I have personally found this README to be quite annoying and difficult to consume.

donnemartin commented

Hi @chrisopedia, thanks for the feedback!