Skip to content

Commit

Permalink
Update README/CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
bf4 committed May 18, 2016
1 parent b089a72 commit fde4f67
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 17 deletions.
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,6 @@
</tr>
</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

ActiveModelSerializers brings convention over configuration to your JSON generation.
Expand All @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -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):
Expand Down Expand Up @@ -156,6 +153,6 @@ serializer.associations
```
See [ARCHITECTURE.md](docs/ARCHITECTURE.md) for more information.

# Contributing
## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

0 comments on commit fde4f67

Please sign in to comment.