README.md in jsonapi-serializers-0.2.6 vs README.md in jsonapi-serializers-0.3.0
- old
+ new
@@ -294,10 +294,18 @@
JSONAPI::Serializer.serialize(post, base_url: 'http://example.com')
```
Note: if you override `self_link` in your serializer and leave out `base_url`, it will not be included.
+### Top-level metadata
+
+You can pass a `meta` argument to specify top-level metadata:
+
+```ruby
+JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Corp.'})
+```
+
## Relationships
You can easily specify relationships with the `has_one` and `has_many` directives.
```ruby
@@ -508,9 +516,10 @@
* Support for the `fields` spec is planned, would love a PR contribution for this.
* Support for pagination/sorting is unlikely to be supported because it would likely involve coupling to ActiveRecord, but please open an issue if you have ideas of how to support this generically.
## Release notes
+* v0.3.0: Add top-level `meta` support.
* v0.2.6: Add `base_url` support.
* v0.2.5: Allow disabling ambiguous collection checks for Sequel support.
* v0.2.4: Improve handling for nil relationship links.
* v0.2.3: Support serializers with no attributes.
* v0.2.2: Compliance fix for excluding empty relationship objects.