Improve documentation

[leggebroten]

Hi,
I like this library you've got here.

It has the potential to be used in many places, but the readme, the first thing people see when they look at the library, is rather sparse with no real indication of why they might use it.

I have several plugins based on your plugin and would love to see this library gain some traction ... potentially to get more types supported.

To that end, would you be open to me providing some PRs that improve the documentation?

-Lee

[tino415]

I'm open to any help, thank you

[tino415]

What is your opinion about forking this repository and have separate library for never version of typedstruct, since it is separate library in hex.pm, I see that mix have hard time to deal with this apis when running tests, or probably, synce moving to 1.0.0, drop older typedstruct

[leggebroten]

Hey @tino415,

It's not actually necessary to fork this library. (I've tested it locally when I added the documentation)
The changes I just submitted remove the dependency on the upstream library.
It can be either typed_struct or typedstruct so long as this library supports the desired interface.

[leggebroten]

As soon as you publish this branch to Hex, I'll submit a PR to the two base libraries mentioning this library in their Plugins section

[leggebroten]

BTW, I have other macros based on this plugin that could drive more traffic to this library.
Let me know when you publish update to Hex, I'll get started

[tino415]

I already published it, still I would prefer to split this package, but it would mess your plugins, maybe target for 2.0.0, because for instance, what if there are some new features in typedstruct that are not part of typed_struct, then it will need to add exception for those in code, etc

[leggebroten]

I think splitting would be the right thing to do when the new typedstruct library adds or changes the plugin interface that you/we want to support. Until then, splitting is not needed at all and might actually make things more difficult and confusing to maintainers and users.

[leggebroten]

If you were to split it how would you go about it?

[tino415]

Probably fork and rename, new hex.pm package etc.