Add instructions to README

[lachiejames]

I spent a few minutes trying to figure out how to use this package to generate type definitions from JSON.

Some of the silly things that I tried are:

• Compiling the code and checking the JS output
• Executing the JS output

Then it occurred to me that the types are generated by logging the result of generateRuntypes(...)

Consider adding this info to the README.

[simenandre]

Hello! 👋

Thanks for opening this issue! I will for sure look into how we can be more clear. One of the maintainers of this project, @runeh, has actually made a tool to generate type definitions from JSON that I suggest you check out: https://github.com/runeh/json-to-runtypes

Which got me thinking, maybe we should add links to projects like json-to-runtypes to our README. To clarify, generate-runtypes aims to be a library that people use to create other utilities, like json-to-runtypes. This project tries to be great at building the source code from a configuration. Does that make sense?

[lachiejames]

Howdy 👋

That json-to-runtypes tool looks useful, I will check it out.

This part confused me a bit since the package is called runtypes-generator, and it is capable of generating runtypes

generate-runtypes aims to be a library that people use to create other utilities

But to be fair, the second sentence in the README is

This package aims to be a great utility for a conversion package

My expectations were off because I arrived here by googling 'how to generate runtypes from JSON' and this was the first result 😂