Documentation

[fkorsa]

Any chance of getting some documentation for this library?

Seems like an awesome way of handling JSON migration, but the barrier to entry is very high without any explanation of how. Reading the tests or the production code example takes a lot of time, especially since there are no explanatory comments.

For example, what does the Migratable attribute do? I am guessing it's in case the class gets renamed, so that the type hash is a persistent identifier that stays the same in case of renaming, but then why do a lot of test cases have an empty string as parameter? Is it simply because they are not testing the renaming support? I'm guessing in production code, one should absolutely never put an empty string in there?

That's just an example of how much guesswork there is to actually use this library. A small documentation that explains the basics would save users a lot of time.

Anyway, thanks a lot for sharing this gem!

[JKronberger]

This library was written some years ago to make it easy, migrating .json data for our main project (CAD/CAM).
Unfortunately we are a pretty small software engineering team and therefore do not have time, to write documentation for Migration.JSon.Net -Sorry. However we use this library in production and it works perfectly for our requirements.

[fkorsa]

I understand, of course. It is already very nice that you took the time to make it open source.

I have dived enough into it to understand most of it, so I may consider writing documentation myself and submitting a PR if I find the time.

Thanks again! Also for the confirmation that it's still stable enough for production purposes.

[JKronberger]

You're welcome! I would appreciate if you find time for docs...