Skip to content

Commit 738894e

Browse files
committed
updating readme declaring JsonApi as default adapter
1 parent 2c9c36e commit 738894e

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ AMS does this through two components: **serializers** and **adapters**.
88
Serializers describe _which_ attributes and relationships should be serialized.
99
Adapters describe _how_ attributes and relationships should be serialized.
1010

11+
By default AMS will use the JsonApi Adapter that follows RC3 of the format specified in [jsonapi.org/format](http://jsonapi.org/format).
12+
Check how to change the adapter in the sections bellow.
13+
1114
# RELEASE CANDIDATE, PLEASE READ
1215

1316
This is the master branch of AMS. It will become the `0.10.0` release when it's
@@ -47,17 +50,17 @@ end
4750
```
4851

4952
Generally speaking, you as a user of AMS will write (or generate) these
50-
serializer classes. If you want to use a different adapter, such as a JsonApi, you can
53+
serializer classes. If you want to use a different adapter, such as a normal Json adapter without the JsonApi conventions, you can
5154
change this in an initializer:
5255

5356
```ruby
54-
ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::JsonApi
57+
ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::Json
5558
```
5659

5760
or
5861

5962
```ruby
60-
ActiveModel::Serializer.config.adapter = :json_api
63+
ActiveModel::Serializer.config.adapter = :json
6164
```
6265

6366
You won't need to implement an adapter unless you wish to use a new format or

0 commit comments

Comments
 (0)