Skip to content

Update headers in readme #8

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.

Sign up for GitHub

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

Open
A-Tawfik wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update headers in readme #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,21 +47,21 @@ return qOrm.qConnect('mysql://username:password@host/database')
});
```

##Supported methods
## Supported methods

- `qOrm.qConnect, qOrm.qExpress`
- `db.qDefine, db.qExecQuery, db.qSync, db.qDrop`
- `Model.qCreate, Model.qGet, Model.qOne, Model.qAll, Model.qCount, Model.qHasOne, Model.qHasMany, Model.qFind`
- `instance.qSave, instance.qRemove, instance.qValidate`
- `instance.qGetAssociatedModel`, etc.

##Notes
## Notes

- All methods inherit their habitual parameters from their callback-based counterparts. (Behind the scenes, we use `Q.nbind`.)
- This is very beta! Works on my application (it's been tested extensively in there), but does not have its own unit tests yet.
- Features such as `orm.enforce`, `orm.eq`, etc. are not wrapped. If you need them (such as in the example), you have to `require('orm')` as well.

##TODO
## TODO

- Tests
- More examples
Expand Down