README.md in mutils-1.0.0 vs README.md in mutils-1.0.1
- old
+ new
@@ -24,11 +24,11 @@
* [Name Tag](#name-tag)
* [Sample Usage](#sample-usage)
## Features
* Simple declaration syntax similar to Active Model Serializer
-* Realtionships support `belongs_to', `has_many`, `has_one`
+* Realtionships support `belongs_to`, `has_many`, `has_one`
* Block style attributes with params
## Installation
Add this line to your application's Gemfile:
@@ -87,11 +87,11 @@
# User Serializer
class UserSerializer < Mutils::Serialization::BaseSerializer
attributes :id, :first_name, :last_name, :email
belongs_to :company, serializer: CompanySerializer, always_include: true
- ##OR
+ ## OR
belongs_to :company, serializer: CompanySerializer, always_include: true, label: 'organization' ##<== important to give singular name
has_many :comments, serializer: CommentSerializer
has_one :account, serializer: AccountSerializer
@@ -207,17 +207,17 @@
```ruby
user = User.first
options = {includes: [:comments,:account]}
UserSerializer.new(user,options).to_h
```
-###or
+### or
```ruby
users = User.all
options = {includes: [:account]}
UserSerializer.new(users,options).to_json
```
-###or in controllers
+### or in controllers
```ruby
users = User.all
options = {includes: [:account]}
users_serializer =UserSerializer.new(users,options)
render json: users_serializer
@@ -232,5 +232,9 @@
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Mutils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/code-vedas/mutils/blob/master/CODE_OF_CONDUCT.md).
+
+## Security
+
+For security refer to [security](https://github.com/Code-Vedas/mutils/blob/master/SECURITY.md) document.