Skip to content

Commit ec60062

Browse files
takaokoujiclaude
andcommitted
Add Speee fork goals and key changes to README
Document the purpose of this fork (modern Rails support and 0.9.x backward compatibility) and summarize key changes from upstream including Rails 7.1-8.1 support, backward compatibility features, and bug fixes. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 76e3dd7 commit ec60062

1 file changed

Lines changed: 32 additions & 2 deletions

File tree

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,36 @@ of your resources, including their attributes and relationships, to make your se
99
JR is designed to work with Rails 5.1+, and provides custom routes, controllers, and serializers. JR's resources may be
1010
backed by ActiveRecord models or by custom objects.
1111

12+
## Speee Fork
13+
14+
This is the [Speee](https://speee.jp/) fork of [jsonapi-resources](https://github.com/cerebris/jsonapi-resources).
15+
16+
### Goals
17+
18+
- **Modern Rails Support**: Enable compatibility with the latest Rails versions (7.1, 7.2, 8.0, 8.1+)
19+
- **0.9.x Backward Compatibility**: Maintain compatibility with code written for jsonapi-resources 0.9.x
20+
21+
### Key Changes from Upstream
22+
23+
#### Rails Compatibility
24+
- Full support for Rails 7.1, 7.2, 8.0, and 8.1
25+
- Rack 3.0 compatibility fixes
26+
- Rails 8.2 deprecation warning fixes
27+
28+
#### 0.9.x Backward Compatibility
29+
- `result.resource` and `result.resources` accessors on operation results
30+
- `apply_filters` method made public for custom filter implementations
31+
- PORO (Plain Old Ruby Object) support in `find_fragments`
32+
33+
#### Bug Fixes
34+
- MySQL compatibility fix for the `quote` method (uses database adapter)
35+
- Ruby 2.6/2.7 compatibility for `Psych.unsafe_load`
36+
37+
#### Development
38+
- Docker support for multi-version Rails testing
39+
- Comprehensive CI matrix covering Ruby 2.6-3.4 and Rails 5.1-8.1
40+
- SimpleCov integration for test coverage measurement
41+
1242
## Documentation
1343

1444
Full documentation can be found at [http://jsonapi-resources.com](http://jsonapi-resources.com), including the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/) specific to this version.
@@ -24,9 +54,9 @@ which *should* be compatible with JSON:API compliant server implementations such
2454

2555
## Installation
2656

27-
### Speee Fork
57+
### Using This Fork
2858

29-
This is the Speee fork of jsonapi-resources. To use this fork, add the following to your application's `Gemfile`:
59+
To use this fork, add the following to your application's `Gemfile`:
3060

3161
```ruby
3262
gem 'jsonapi-resources', github: 'speee/jsonapi-resources', tag: 'v26.1.1'

0 commit comments

Comments
 (0)