cartodb/node-postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add note on impending breaking changes to readme

Browse Source
This commit is contained in:
Brian C 2013-03-11 15:27:16 -05:00
parent 07d7c259a5
commit 0d0737d67b
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -82,6 +82,17 @@ The two share the same interface so __no other code changes should be required__
* bulk import & export with `COPY TO/COPY FROM`
* extensible js<->postgresql data-type coercion
## Heads Up!!
node-postgres is __very__ near to v1.0.0 release. Up until now I've tried to maintain all backwards compatilbity, but there are a few breaking changes the community has recommended I introduce.
The current version will spit out deprecation warnings when you use the soon-to-be-deprecated features. They're meant to be obtrusive and annoying. Understandable if you'd like to disable them.
You can do so like this: `pg.defaults.hideDeprecationWarnings = true;`
These are the breaking changes: https://github.com/brianc/node-postgres/pull/301
## Documentation
Documentation is a work in progress primarily taking place on the github WIKI