README.md in basic_serializer-0.1.2 vs README.md in basic_serializer-0.1.3
- old
+ new
@@ -1,8 +1,6 @@
# BasicSerializer
-[![Gem Version](https://badge.fury.io/rb/basic_serializer.svg)](https://badge.fury.io/rb/basic_serializer)
-
[![Ruby](https://github.com/aladac/basic_serializer/actions/workflows/main.yml/badge.svg)](https://github.com/aladac/basic_serializer/actions/workflows/main.yml)
This is a simple serializer for Ruby objects without heavy dependencies.
## Installation
@@ -21,16 +19,19 @@
class UserSerializer < BasicSerializer
attribute :id, :integer
attribute :name, :string
attribute :email, :string
+ format :json, pretty: true
+
model_name "User" # optional model name metadata
schema_ref "#/components/schemas/User" # optional swagger schema reference
end
serializer = UserSerializer.new(name: 'Foobar', email: 'email@domain.com', id: 1)
serializer.to_json
-serializer.as_json
+serializer.to_yaml
+serializer.serialize
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.