mention jsonapi-rb for people specifically looking for jsonapi serialization #2195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bf4
reviewed
Sep 19, 2017
README.md
Outdated
|
|
||
| In the mean time, if you're looking for a json:api renderer, [jsonapi-rb](http://jsonapi-rb.org/) will meet your needs -- | ||
| with a [performance boost](https://gist.github.com/NullVoxPopuli/748e89ddc1732b42fdf42435d773734a), too. | ||
|
|
There was a problem hiding this comment.
Maybe instead of adding this text here, add here a link to [Development Status](#status-of-ams) and then put this down there?
There was a problem hiding this comment.
And maybe reference https://github.com/rails-api/active_model_serializers/tree/benchmarks per discussion in #2169 ??
bf4
reviewed
Sep 19, 2017
README.md
Outdated
| @@ -41,6 +43,13 @@ Please see below for the documentation relevant to you. | |||
| - ❗️ 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. | |||
|
|
|||
| In the mean time, if you're looking for a json:api renderer, [jsonapi-rb](http://jsonapi-rb.org/) will meet your needs -- | |||
| with a [performance boost](https://gist.github.com/NullVoxPopuli/748e89ddc1732b42fdf42435d773734a), too. | |||
There was a problem hiding this comment.
Maybe something like?
### 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
There was a problem hiding this comment.
works for me!
bf4
reviewed
Sep 19, 2017
README.md
Outdated
| - [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 | ||
|
|
||
| *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 |
There was a problem hiding this comment.
I should probably actually have a different subheader for this stuff
bf4
reviewed
Sep 19, 2017
README.md
Outdated
| @@ -2,6 +2,8 @@ | |||
|
|
|||
| ## About | |||
|
|
|||
| ActiveModelSerializers is undergoing some renovations. see [Development Status](#status-of-ams) | |||
bf4
reviewed
Sep 19, 2017
| ## Installation | ||
|
|
||
| ## Getting Started | ||
| ActiveModelSerializers is undergoing some renovations. See [Development Status](#status-of-ams). |
bf4
reviewed
Sep 19, 2017
README.md
Outdated
|
|
||
| *Changes to 0.10.x maintenance*: | ||
|
|
||
| ### *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 |
There was a problem hiding this comment.
would you mind fixing the typo whilst here? s/version/burden? and add a period to end of bullet line?
bf4
reviewed
Sep 19, 2017
README.md
Outdated
| - [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) |
There was a problem hiding this comment.
since you're making changes, I guess remove the 0.10.6 stuff and make more in line with 0-9 and 0-8
NullVoxPopuli
commented
Sep 19, 2017
README.md
Outdated
| - [](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable) | ||
| <table> | ||
| <tr> | ||
| <td> [0.10 (0-10-stable) Documentation](https://github.com/rails-api/active_model_serializers/tree/0-10-stable) </td> |
There was a problem hiding this comment.
this looks better in atom. :-\
NullVoxPopuli
commented
Sep 19, 2017
| - [](http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable) | ||
| <table> | ||
| <tr> | ||
| <td> |
There was a problem hiding this comment.
html. blegh. but the result is nice.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just a simple note.