Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fotinakis committed Jun 3, 2015
1 parent a9eeffb commit 5ecc724
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
[![Build Status](https://travis-ci.org/fotinakis/jsonapi-serializers.svg?branch=master)](https://travis-ci.org/fotinakis/jsonapi-serializers)
[![Gem Version](https://badge.fury.io/rb/jsonapi-serializers.svg)](http://badge.fury.io/rb/jsonapi-serializers)


JSONAPI::Serializers is a simple library for serializing Ruby objects and their relationships into the [JSON:API format](http://jsonapi.org/format/).

As of writing, the JSON:API spec is approaching v1 and still undergoing changes. This library supports RC3+ and aims to keep up with the continuing development changes.
This library is up-to-date with the finalized v1 JSON API spec.

* [Features](#features)
* [Installation](#installation)
Expand Down Expand Up @@ -433,6 +432,10 @@ end
* 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.2.0: Initial release with support for the final v1 JSON API spec.

## Contributing

1. Fork it ( https://github.com/fotinakis/jsonapi-serializers/fork )
Expand Down

0 comments on commit 5ecc724

Please sign in to comment.