Transforms docs in README are old/incorrect about conform

[martin-langhoff]

Don't worry about my "impractical" complaint, I was wrapping my mind around the new API. Apologies.

The important part is to get a current example to the README :-) (alternatively, remove the wrong example and point people to unit tests and source instead...).

[sdball]

Thanks for this @martin-langhoff! I was just struggling with trying to get transforms to work and even copied the schema from the README entirely into my app to see if I was missing some critical piece. Your example is great 🎉

[bitwalker]

Sorry about that, I somehow completely missed updating the README when I released 2.0, nothing worse than bad docs :(

[bitwalker]

@martin-langhoff I'll make sure the docs get updated! You mentioned that the new API format is impractical, could you clarify your concerns? Your specific example is not much longer than alternatives I can think of, but has the benefit of scaling to some very complex configuration requirements. Is there a specific issue you would like to see addressed?

[sdball]

No worries! I'll try and take a pass at updating the README. It'll also help me learn the ins and outs of conform. 😄

[sdball]

@bitwalker I've got the myapp.another_val transform example working. But I'm having a hard time figuring out how to make the lager settings work. It looks like Conform.Conf.get needs to pull the actual setting that the variable is going to and not its friendly id. If that's the case I don't quite understand how to translate the previous example for 2.0. I don't see how the transform can add new keys to the effective configuration.

Let me know if I'm missing something, but I think I'll need to rework the schema a bit in order to support that example.

Also in the README now there's some nice extra documentation for myapp.another_val: how is that generated? My generated conf file only has the doc line the allowed values from the enum.

[bitwalker]

I've gone through and updated the README, and added tests which cover the examples.