mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-22 22:06:50 +00:00
mention jsonapi-rb for people specifically looking for jsonapi serialization (#2195)
Clean up readme and add alternatives section
This commit is contained in:
parent
6a029595ff
commit
e8f3ec8ab7
74
README.md
74
README.md
@ -2,9 +2,7 @@
|
||||
|
||||
## About
|
||||
|
||||
## Installation
|
||||
|
||||
## Getting Started
|
||||
ActiveModelSerializers is undergoing some renovations. See [Development Status](#status-of-ams).
|
||||
|
||||
## Getting Help
|
||||
|
||||
@ -22,31 +20,63 @@ Thanks!
|
||||
If you're reading this at https://github.com/rails-api/active_model_serializers you are
|
||||
reading documentation for our `master`, which is not yet released.
|
||||
|
||||
Please see below for the documentation relevant to you.
|
||||
|
||||
- [0.10 (0-10-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-10-stable)
|
||||
- [0.10.6 (latest release) Documentation](https://github.com/rails-api/active_model_serializers/tree/v0.10.6)
|
||||
- [](http://www.rubydoc.info/gems/active_model_serializers/0.10.6)
|
||||
- [Guides](https://github.com/rails-api/active_model_serializers/tree/v0.10.6/docs)
|
||||
- [0.9 (0-9-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
|
||||
- [](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)
|
||||
- [](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable)
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<a href='https://github.com/rails-api/active_model_serializers/tree/0-10-stable'>0.10 (0-10-stable) Documentation
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href='http://www.rubydoc.info/gems/active_model_serializers/0.10.6'>
|
||||
<img src='http://img.shields.io/badge/yard-docs-blue.svg' />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href='https://github.com/rails-api/active_model_serializers/tree/v0.10.6/docs'>
|
||||
Guides
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href='https://github.com/rails-api/active_model_serializers/tree/0-9-stable'>0.9 (0-9-stable) Documentation
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href='http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable'>
|
||||
<img src='http://img.shields.io/badge/yard-docs-blue.svg' />
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href='https://github.com/rails-api/active_model_serializers/tree/0-8-stable'>0.8 (0-8-stable) Documentation
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href='http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable'>
|
||||
<img src='http://img.shields.io/badge/yard-docs-blue.svg' />
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
## Status of AMS
|
||||
|
||||
*Status*:
|
||||
### *Status*:
|
||||
|
||||
- ❗️ All existing PRs against master will need to be closed and re-opened against 0-10-stable, if so desired
|
||||
- ❗️ Master, for the moment, won't have any released version of AMS on it.
|
||||
- :eyes: See below for [alternatives](#alternatives)
|
||||
|
||||
*Changes to 0.10.x maintenance*:
|
||||
|
||||
- The 0.10.x version has become a huge maintenance version. We had hoped to get it in shape for a 1.0 release, but it is clear that isn't going to happen. Almost none of the maintainers from 0.8, 0.9, or earlier 0.10 are still working on AMS. We'll continue to maintain 0.10.x on the 0-10-stable branch, but maintainers won't otherwise be actively developing on it
|
||||
### *Changes to 0.10.x maintenance*:
|
||||
|
||||
- The 0.10.x version has become a huge maintenance version. We had hoped to get it in shape for a 1.0 release, but it is clear that isn't going to happen. Almost none of the maintainers from 0.8, 0.9, or earlier 0.10 are still working on AMS. We'll continue to maintain 0.10.x on the 0-10-stable branch, but maintainers won't otherwise be actively developing on it.
|
||||
- We may choose to make a 0.11.x ( 0-11-stable) release based on 0-10-stable that just removes the deprecations.
|
||||
|
||||
*What's happening to AMS*:
|
||||
### *What's happening to AMS*:
|
||||
|
||||
- There's been a lot of churn around AMS since it began back in [Rails 3.2](CHANGELOG-prehistory.md) and a lot of new libraries are around and the JSON:API spec has reached 1.0.
|
||||
- If there is to be a 1.0 release of AMS, it will need to address the general needs of serialization in much the way ActiveJob can be used with different workers.
|
||||
@ -56,9 +86,15 @@ Please see below for the documentation relevant to you.
|
||||
|
||||
See [PR 2121](https://github.com/rails-api/active_model_serializers/pull/2121) where these changes were introduced for more information and any discussion.
|
||||
|
||||
## High-level behavior
|
||||
|
||||
## Architecture
|
||||
|
||||
## Alternatives
|
||||
|
||||
- [jsonapi-rb](http://jsonapi-rb.org/) is a [highly performant](https://gist.github.com/NullVoxPopuli/748e89ddc1732b42fdf42435d773734a) and modular JSON:API-only implementation. There's a vibrant community around it that has produced projects such as [JSON:API Suite](https://jsonapi-suite.github.io/jsonapi_suite/).
|
||||
|
||||
For benchmarks against alternatives, see https://github.com/rails-api/active_model_serializers/tree/benchmarks
|
||||
|
||||
|
||||
|
||||
## Semantic Versioning
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user