Skip to content

Commit 0d0737d

Browse files
committed
add note on impending breaking changes to readme
1 parent 07d7c25 commit 0d0737d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,17 @@ The two share the same interface so __no other code changes should be required__
8282
* bulk import & export with `COPY TO/COPY FROM`
8383
* extensible js<->postgresql data-type coercion
8484

85+
## Heads Up!!
86+
87+
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.
88+
89+
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.
90+
91+
You can do so like this: `pg.defaults.hideDeprecationWarnings = true;`
92+
93+
These are the breaking changes: https://github.com/brianc/node-postgres/pull/301
94+
95+
8596
## Documentation
8697

8798
Documentation is a work in progress primarily taking place on the github WIKI

0 commit comments

Comments
 (0)