Missing documentation

[weeco]

I'm submitting a...

[ ] Regression 
[ ] Bug report
[ ] Feature request
[X] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

No docs at all

Expected behavior

Documentation on docs.nestjs.com

I'd like to try nest-terminus and I am looking for a detailed documentation which I can test in a "blackbox" fashion without looking at the code.

[BrunnerLivio]

Thank you for your report. I am currently working on here. The problem is I am quite busy at the moment, and while writing down the documentation and thinking about issue #2 I do not know if it is the best option to release it as it is know.

I do not want to release nest terminus and break the API in the next release. So I think we should fix #2 first and then release it. What do you think?

[BrunnerLivio]

If my proposal gets accepted, I'll complete the docs as soon as possible (because that means the upcoming "predefined health checks"will not introduce breaking changes) and release the first version. After that I'll try to actually implement the mentioned proposal.

[BrunnerLivio]

@weeco see nestjs/docs.nestjs.com#198