search

EqualExperts / Tayra

Incremental backup tool for MongoDB
Other
142 stars 29 forks source link

Add documentation #2

Closed benmccann closed 11 years ago

benmccann commented 11 years ago

I just found this project and it seems really cool, but there's no documentation, so it'd be pretty impossible to use without digging through the source code.

DhavalDalal commented 11 years ago

Hi Ben, If you are wanting binary distributions, you can download it from http://www.equalexperts.com/eelabs/projects/tayra/ and it has the necessary documentation. If you find that insufficient, we would be more than happy to incorporate your feedback. However, if you are looking to contribute to the project, then yes there is no formal documentation; we rely on our specifications (tests) to be our documentation for now. A good point to start would be RunnerSpecs in absence of formal documentation. As we are constantly changing things, formal documentation will be an overhead at this point in time. Let me know what we can do for you.

Cheers.

benmccann commented 11 years ago

Oh, great! I didn't realize there were docs in the binary. I'm used to most documentation being on websites these days. It could be good to put a short note on the GitHub README saying that there's a usage doc in the downloadable zip.