diff --git a/Client.md b/Client.md index 5919a57..d81d0d2 100644 --- a/Client.md +++ b/Client.md @@ -63,7 +63,7 @@ Creates a new, unconnected instance of a Client configured via supplied configur - whether to try SSL/TLS to connect to server -#### example +#### tcp example ```javascript var client = new Client({ @@ -75,6 +75,20 @@ Creates a new, unconnected instance of a Client configured via supplied configur }); ``` +#### domain socket example + +Will look for the Unix Domain Socket at `/tmp/.s.PGSQL.5313` and connect with the rest of the supplied credentials: + +```javascript + var client = new Client({ + user: 'brianc', + password: 'boom!', + database: 'test', + host: '/tmp', + port: 5313 + }); +``` + ## Methods