From b089a7277d6fc5422534bd97a0df0fe5f7fbcc1d Mon Sep 17 00:00:00 2001 From: Benjamin Fleischer Date: Wed, 18 May 2016 10:16:05 -0500 Subject: [PATCH 1/2] Correct ruby/rails version requirements in gemspec --- active_model_serializers.gemspec | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/active_model_serializers.gemspec b/active_model_serializers.gemspec index ae2578892..62588f376 100644 --- a/active_model_serializers.gemspec +++ b/active_model_serializers.gemspec @@ -19,9 +19,9 @@ Gem::Specification.new do |spec| spec.require_paths = ['lib'] spec.executables = [] - spec.required_ruby_version = '>= 2.0.0' + spec.required_ruby_version = '>= 2.1' - rails_versions = '>= 4.0' + rails_versions = ['>= 4.1', '< 6'] spec.add_runtime_dependency 'activemodel', rails_versions # 'activesupport', rails_versions # 'builder' From fde4f6776dd52f2b57014a3dd5a18927dacfd016 Mon Sep 17 00:00:00 2001 From: Benjamin Fleischer Date: Wed, 18 May 2016 10:23:10 -0500 Subject: [PATCH 2/2] Update README/CHANGELOG --- CHANGELOG.md | 10 +++++++++- README.md | 29 +++++++++++++---------------- 2 files changed, 22 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f9b24dfe..0684c14a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,15 @@ ### [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: - [#1662](https://github.com/rails-api/active_model_serializers/pull/1662) Drop support for Rails 4.0 and Ruby 2.0.0. (@remear) diff --git a/README.md b/README.md index 2cb0800b0..30ebe626a 100644 --- a/README.md +++ b/README.md @@ -24,17 +24,6 @@ - -## 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 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 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 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. @@ -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. -For more information, see the post '[The future of -AMS](https://medium.com/@joaomdmoura/the-future-of-ams-e5f9047ca7e9)'. - ## Installation 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! +## 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 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. -# Contributing +## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md)