Please add/update demo and documentation

[wforney]

The documentation is old and doesn't work with the NuGet package or source.

[dylanbeattie]

+1

The documentation refers to

JsonApiFormatter formatter = new JSONAPI.Json.JsonApiFormatter();
formatter.PluralizationService = new JSONAPI.Core.PluralizationService();
GlobalConfiguration.Configuration.Formatters.Add(formatter);

but in the current source (and NuGet release) there is no parameterless constructor on JsonApiFormatter - and the only public constructor available requires a pretty complicated dependency graph.

There's also, as far as I can tell, no explicit usage of this constructor usage anywhere in the project. I'm guessing you've rewired the whole thing to use an IoC container (Autofac?) by design, but without documentation explaining how we go about doing this I honestly have no idea how I'm supposed to instantiate a formatter and inject it into my WebAPI configuration.

It looks like a great library, though... just a bit of a learning curve to get up and running!

Thanks,

-D-

[dylanbeattie]

Ah... I just found

#96

which includes, at the end of a very long TODO list:

• Update README

Anything I can do to help with this?

[csantero]

I apologize for the sad state of NuGet... I haven't pushed a new version because the documentation is out of date, and I haven't updated the documentation because I am quite unhappy with the current APIs for configuration. After using it in my app for the last 6-7 months, I have become severely frustrated with IDocumentMaterializer and IJsonApiConfiguration. At the current time, it is my opinion JSONAPI.NET does not offer a satisfactory workflow for API developers. I have some ideas for how to address this, but I haven't had the time to really apply them, and I don't expect to have the time to do so for at least another couple months.

@dylanbeattie I would be happy to accept a PR updating the README and wiki to reflect the current state of master. You are right that #96 represents the closest thing we have to guidance, though some things have changed since then. #103 has a few notes you might find helpful too. Feel free to shoot me up if you have any questions. Thanks!