ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-22 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README/CHANGELOG

Browse Source
This commit is contained in:
Benjamin Fleischer 2016-05-18 10:23:10 -05:00
parent b089a7277d
commit fde4f6776d
2 changed files with 22 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CHANGELOG.md
View File

@ -2,7 +2,15 @@
### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.0...master) ### [master (unreleased)](https://github.com/rails-api/active_model_serializers/compare/v0.10.0...master)
### v0.10.0 (2016-05-17) Breaking changes:
Features:
Fixes:
Misc:
### [v0.10.0 (2016-05-17)](https://github.com/rails-api/active_model_serializers/compare/4a2d9853ba7...v0.10.0)
Breaking changes: Breaking changes:
- [#1662](https://github.com/rails-api/active_model_serializers/pull/1662) Drop support for Rails 4.0 and Ruby 2.0.0. (@remear) - [#1662](https://github.com/rails-api/active_model_serializers/pull/1662) Drop support for Rails 4.0 and Ruby 2.0.0. (@remear)

29
README.md
View File

@ -24,17 +24,6 @@
</tr> </tr>
</table> </table>
## Documentation
- [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/tree/master)
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/v0.10.0)
- [Guides](docs)
- [0.9 (0-9-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable)
- [0.8 (0-8-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-8-stable)
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable)
## About ## About
ActiveModelSerializers brings convention over configuration to your JSON generation. ActiveModelSerializers brings convention over configuration to your JSON generation.
@ -50,7 +39,7 @@ resource serialization. The serialization has the `#as_json`, `#to_json` and `#s
methods used by the Rails JSON Renderer. (SerializableResource actually delegates methods used by the Rails JSON Renderer. (SerializableResource actually delegates
these methods to the adapter.) these methods to the adapter.)
By default ActiveModelSerializers will use the **Attributes Adapter**. By default ActiveModelSerializers will use the **Attributes Adapter** (no JSON root).
But we strongly advise you to use **JsonApi Adapter**, which But we strongly advise you to use **JsonApi Adapter**, which
follows 1.0 of the format specified in [jsonapi.org/format](http://jsonapi.org/format). follows 1.0 of the format specified in [jsonapi.org/format](http://jsonapi.org/format).
Check how to change the adapter in the sections below. Check how to change the adapter in the sections below.
@ -62,9 +51,6 @@ architecture. We'd love your help. [Learn how you can help here.](CONTRIBUTING.m
It is generally safe and recommended to use the master branch. It is generally safe and recommended to use the master branch.
For more information, see the post '[The future of
AMS](https://medium.com/@joaomdmoura/the-future-of-ams-e5f9047ca7e9)'.
## Installation ## Installation
Add this line to your application's Gemfile: Add this line to your application's Gemfile:
@ -97,6 +83,17 @@ If you'd like to chat, we have a [community slack](http://amserializers.herokuap
Thanks! Thanks!
## Documentation
- [0.10 (master) Documentation](https://github.com/rails-api/active_model_serializers/tree/master)
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/v0.10.0)
- [Guides](docs)
- [0.9 (0-9-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable)
- [0.8 (0-8-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-8-stable)
- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable)
## High-level behavior ## High-level behavior
Given a [serializable model](lib/active_model/serializer/lint.rb): Given a [serializable model](lib/active_model/serializer/lint.rb):
@ -156,6 +153,6 @@ serializer.associations
``` ```
See [ARCHITECTURE.md](docs/ARCHITECTURE.md) for more information. See [ARCHITECTURE.md](docs/ARCHITECTURE.md) for more information.
# Contributing ## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) See [CONTRIBUTING.md](CONTRIBUTING.md)