README.md in fast_serializer-1.1.2 vs README.md in fast_serializer-1.1.3
- old
+ new
@@ -1,7 +1,8 @@
-[](https://travis-ci.org/weheartit/fast_serializer)
-[](https://codeclimate.com/github/bdurand/fast_serializer/maintainability)
+[](https://github.com/bdurand/fast_serializer/actions/workflows/continuous_integration.yml)
+[](https://github.com/bdurand/fast_serializer/actions/workflows/regression_test.yml)
+[](https://github.com/testdouble/standard)
This gem provides a highly optimized framework for serializing Ruby objects into hashes suitable for serialization to some other format (i.e. JSON). It provides many of the same features as other serialization frameworks like active_model_serializers, but it is designed to emphasize code efficiency over feature set and syntactic surgar.
## Examples
@@ -230,9 +231,35 @@
```ruby
PersonSerializer.array([a, b, c, d])
```
-
## Performance
Your mileage may vary. In many cases the performance of the serialization code doesn't particularly matter and this gem performs just about as well as other solutions. However, if you do have high throughput API or can utilize the caching features or have heavily nested models in your JSON responses, then the performance increase may be noticeable.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fast_serializer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install fast_serializer
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).