Skip to content

Commit

Permalink
docs(README): fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
borodayev committed Jan 9, 2019
1 parent bed49cd commit 3fad063
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ After adding, the plugin will create a diff document with the following shape in
}
```

**Important!** Plugin creates diffs on a `preSave` mongoose hook. That's why all methods which directly operates with MongoDB won't call creating diff.
**Important!** Plugin creates diffs on a `preSave` mongoose hook. That's why all methods which directly operates with MongoDB won't invoke creating diff. Also, plugin increment `versionKey` in your collection after any modification.

Diffs are represented as one or more change records. Change records have the following structure:

Expand Down

0 comments on commit 3fad063

Please sign in to comment.