Add the mapping from HCL -> JSON to the README?

[virtuald]

The mapping from HCL to JSON (and vice versa) isn't immediately clear. I haven't been able to find concrete documentation for this yet. The fixtures help, but there seems to be a mix of valid/invalid examples.

[josephholsten]

that's why I built hcl2json in #24. would you take a look and tell me what else you'd like in it?

[virtuald]

I don't really use go for anything, and don't really have the time to do it. pyhcl comes with a similar script called 'hcltool' which does exactly this, however. I imagine they will typically have the same output -- but in the cases they don't,it's probably because HCL is still murkily specified.

[josephholsten]

Would it be useful to have a test suite that allows us to verify the resultant documents are identical at the CLI level? That'll probably be too large to fit into the readme.

[virtuald]

There sorta already is such a test suite, but I think the key thing missing is a clearer formal specification of the mapping.

[timgent]

+1 for this. The tool is useful, but documentation would help to supplement this. It would still be useful to have a few examples in the docs for how to convert between them, so that at a glance you can see how the mapping works.

[sheerun]

Yes, please..

[timgent]

I will rebase this if someone is able to merge it in?
#36