Skip to content

Commit 33f08d9

Browse files
guilleiguaranshishirmk
authored andcommitted
Update README to include docs about the Rails generator
1 parent 013f01d commit 33f08d9

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Fast JSON API serialized 250 records in 3.01 ms
2121
* [Features](#features)
2222
* [Installation](#installation)
2323
* [Usage](#usage)
24+
* [Rails Generator](#rails-generator)
2425
* [Model Definition](#model-definition)
2526
* [Serializer Definition](#serializer-definition)
2627
* [Object Serialization](#object-serialization)
@@ -55,6 +56,14 @@ $ bundle install
5556

5657
## Usage
5758

59+
### Rails Generator
60+
You can use the bundled generator if you are using the library inside of
61+
a Rails project:
62+
63+
rails g Serializer Movie name year
64+
65+
This will create a new serializer in `app/serializers/movie_serializer.rb`
66+
5867
### Model Definition
5968

6069
```ruby

0 commit comments

Comments
 (0)