Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that you can increment by values other than 1. #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Use this module at your own risk, or better yet, not at all.
- number#$inc
- number#$dec

All methods default to incrementing or decrementing by 1. You can increment by other values by passing a different number to the methods:

part.num.increment(5); // increment by 5

## Compatibility

- mongoose-number 0.0.2 is compatibile with `Mongoose >= v3.0.0 < v3.6.0`
Expand Down