search

kamikat / moshi-jsonapi

JSON API v1.0 Specification in Moshi.
MIT License
156 stars 34 forks source link

Ambiguous documentation #4

Closed lordplagus02 closed 8 years ago

lordplagus02 commented 8 years ago

This code doesn't compile:

String json = "...";

Moshi.Builder builder = new Moshi.Builder();
builder.add(ResourceAdapterFactory.builder()
        .add(Article.class)
        .add(Person.class)
        .add(Comment.class)
        .build());

Article[] articles = moshi.adapter(Articles[].class).fromJson(json);

The readme needs a proper explanation of how to set up the adapter for version 2.x because due to all the breaking changes, it no longer makes sense.

kamikat commented 8 years ago

Thanks. I've updated the documentation. Is it clear enough now?