Revamp nconf documentation
Hello,
nconf is great but the docs are not complete and not clear about some features. I have noticed the docs/ folder in the repo (however not updated since 4 years). I think it was never finished, if you want to look at it I have hosted it on my Google Drive here.
I use nconf for almost all my project with node (personal and at work) and I think that a rewrite of the documentation is needed. I think I'm not the only one who need this: #140, #138 and #148 for the most recents.
Before working on a pull request, I would like to gather feedbacks/answers:
- @indexzero what is the state of the projet? I notice many unclosed issues and pull requests waiting. Is there something I'm not aware of?
- How would you like to implement it? Github wiki or
*.mdguides indocs/should be enough IMO
Any feedback would be appreciated.
Just found jsdox which generates markdown files from jsdoc comments.
This can be a good quickstart since the project already use jsdoc, I'll make some tests to better document get().
@Oza94 a rewrite of README.md would be very welcome.