Improve readme

porsager · porsager · commit 712088c4b4b4 · 2019-12-18T15:42:34.000+01:00
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
-# Postgres.js
+
+
+<img align="left" width="460" height="124" alt="Fastest full PostgreSQL nodejs client" src="postgresjs.svg" />
+
 
 - 🚀 Fastest full featured PostgreSQL client for Node.js
 - 🚯 1300 LOC - 0 dependencies
@@ -7,6 +10,10 @@
 
 ## Getting started
 
+<br>
+<img height="220" alt="Good UX with Postgres.js" src="demo.gif" />
+<br>
+
 **Install**
 ```bash
 $ npm install postgres
@@ -15,7 +22,7 @@ $ npm install postgres
 **Use**
 ```js
 
-import postgres from 'postgres'
+const postgres = require('postgres')
 
 const sql = postgres({ ...options }) // will default to the same as psql
 
@@ -27,13 +34,6 @@ const something = await sql`
 
 ```
 
-**Node pre 13.1.0**
-```js
-
-const postgres = require('postgres/cjs')
-
-```
-
 ## Connection options
 
 You can use either a postgres:// url connection string or the options to define your database connection properties.
@@ -44,9 +44,9 @@ const sql = postgres('postgres://user:pass@host:port/database', {
   host        : '',         // or hostname
   port        : 5432,       // Postgres server port
   path        : '',         // unix socket path (usually '/tmp')
-  database    : '',         // Database to connect to
-  username    : '',         // or username
-  password    : '',         // or password
+  database    : '',         // or db
+  username    : '',         // or user
+  password    : '',         // or pass
   ssl         : false,      // True, or options for tls.connect
   max         : 10,         // Max number of connections
   timeout     : 0,          // Idle connection timeout in seconds
diff --git a/demo.gif b/demo.gif
diff --git a/postgresjs.svg b/postgresjs.svg
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 24.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 483 120" style="enable-background:new 0 0 483 120;" xml:space="preserve">
+<g>
+	<path d="M88.6,90.5c-0.8,0-1.6-0.4-2.1-1.2c-0.7-1.2-0.4-2.7,0.8-3.5l4.9-3.1c0,0,0.1,0,0.1,0c2.6-1.5,4.3-4.4,4.3-7.4V43
+		c0-3-1.6-5.9-4.3-7.4c0,0,0,0-0.1,0L64.3,18.2c-1.2-0.7-2.3-0.2-2.7,0c-0.4,0.2-1.4,1-1.4,2.4v36.5c0,2.7,1.4,5.1,3.6,6.5
+		c2.3,1.4,5,1.5,7.4,0.3l6.9-3.4c1.2-0.6,2.7-0.1,3.4,1.1c0.6,1.2,0.1,2.7-1.1,3.4l-6.9,3.4c-3.9,2-8.5,1.8-12.3-0.6
+		c-3.7-2.3-6-6.3-6-10.7V20.6c0-2.8,1.5-5.3,3.9-6.7c2.4-1.4,5.3-1.4,7.8,0c0,0,0,0,0.1,0l27.9,17.4c4.2,2.4,6.7,6.9,6.7,11.7v32.4
+		c0,4.8-2.6,9.3-6.7,11.7l-4.9,3.1C89.5,90.4,89.1,90.5,88.6,90.5z"/>
+</g>
+<g>
+	<path d="M52.4,102.9c-1.3,0-2.6-0.3-3.8-1L24.9,88.5c0,0,0,0,0,0c-4.5-2.6-7.4-7.5-7.4-12.8V53c0-6.7,3.6-12.9,9.3-16.2l16.7-9.8
+		c1.2-0.7,2.7-0.3,3.4,0.9c0.7,1.2,0.3,2.7-0.9,3.4l-16.7,9.8c0,0,0,0,0,0c-4.2,2.4-6.8,7-6.8,11.9v22.7c0,3.5,1.9,6.7,4.8,8.4
+		L51,97.5c0,0,0,0,0,0c1.2,0.7,2.3,0.2,2.7,0c0.4-0.2,1.3-0.9,1.3-2.3V78.1c0-1.4,1.1-2.5,2.5-2.5c1.4,0,2.5,1.1,2.5,2.5v17.1
+		c0,2.8-1.4,5.3-3.8,6.7C55.1,102.6,53.7,102.9,52.4,102.9z"/>
+</g>
+<g>
+	<path d="M127,44.9c0-0.5,0.4-0.9,0.9-0.9h10.4c5.8,0,10.6,4.7,10.6,10.4c0,5.9-4.8,10.6-10.5,10.6h-7.8v11.1c0,0.5-0.4,0.9-0.9,0.9
+		h-1.8c-0.5,0-0.9-0.4-0.9-0.9V44.9z M138.1,61.6c3.9,0,7.2-2.9,7.2-7.2c0-4.2-3.3-6.8-7.2-6.8h-7.5v14H138.1z"/>
+	<path d="M162.7,54.8c6,0,11,5.2,11,11.3c0,6.2-4.9,11.5-11,11.5c-6,0-11-5.2-11-11.5C151.7,60,156.6,54.8,162.7,54.8z M162.7,74.4
+		c4.3,0,7.5-3.8,7.5-8.3c0-4.4-3.2-8.2-7.5-8.2c-4.3,0-7.5,3.7-7.5,8.2C155.2,70.6,158.4,74.4,162.7,74.4z"/>
+	<path d="M178.5,74.9c-0.2-0.2-0.3-0.6-0.1-0.9l0.7-1.2c0.3-0.5,0.7-0.7,1.3-0.3c0.8,0.6,2.6,1.9,5.4,1.9c2.2,0,3.7-1,3.7-2.7
+		c0-2.1-1.7-2.9-4.9-4.5c-2.9-1.4-6.2-3-6.2-6.7c0-2.3,1.7-5.7,6.8-5.7c2.8,0,5.2,0.9,6.2,1.7c0.5,0.4,0.6,0.8,0.2,1.5l-0.5,0.9
+		c-0.3,0.6-1,0.7-1.5,0.4c-0.9-0.6-2.5-1.3-4.5-1.3c-2.4,0-3.2,1.4-3.2,2.4c0,1.9,1.5,2.6,4.2,3.9c3.8,1.7,7,3.2,7,7.1
+		c0,3.4-3,6.2-7.4,6.2C182,77.6,179.6,76,178.5,74.9z"/>
+	<path d="M197.3,58.3c-0.7,0-1.1-0.5-1.1-1v-0.9c0-0.6,0.4-1,1.1-1h2.9v-6c0-0.6,0.5-1,1-1l1.5-0.1c0.6,0,1,0.5,1,1v6.1h6.4
+		c0.6,0,1.1,0.4,1.1,1v0.9c0,0.6-0.5,1-1.1,1h-6.4v13c0,2.3,0.7,3.1,1.9,3.1c2,0,3.4-0.8,4.3-1.4c0.8-0.5,1.1-0.1,1.4,0.4l0.4,1
+		c0.3,0.7,0.2,1-0.4,1.4c-0.9,0.7-3.2,1.7-6.1,1.7c-4.2,0-5-2.6-5-6V58.3H197.3z"/>
+	<path d="M235.1,77.2c0,7.5-4.6,10.2-9.5,10.2c-3.4,0-6.5-1.8-7.6-2.8c-0.4-0.3-0.5-0.9-0.2-1.3l0.9-1.4c0.3-0.5,0.9-0.5,1.4,0
+		c1.2,1,3.1,2.3,5.5,2.3c3.4,0,6.1-1.9,6.1-7v-1.6c0,0-2.5,1.9-6,1.9c-6,0-10.3-5.1-10.3-11.4c0-6.2,4.2-11.4,10.2-11.4
+		c3.9,0,6.5,2.2,6.5,2.2l0.3-1c0.2-0.4,0.5-0.8,1-0.8h0.7c0.6,0,1.1,0.5,1.1,1V77.2z M226.1,74.3c3,0,5.5-1.8,5.5-1.8V60.6
+		c0,0-2.2-2.6-5.8-2.6c-4.3,0-7,3.9-7,8.1C218.8,70.8,221.9,74.3,226.1,74.3z"/>
+	<path d="M242.5,56.3c0-0.5,0.5-1,1-1h0.8c0.4,0,0.8,0.2,0.9,0.8l0.4,1.6c0,0,2.2-2.8,6.7-2.8c1.7,0,4.3,0.2,3.8,1.7l-0.6,1.7
+		c-0.2,0.7-0.8,0.8-1.3,0.5c-0.5-0.2-1.3-0.6-2.4-0.6c-4.2,0-5.9,2.8-5.9,2.8V76c0,0.6-0.5,1-1,1h-1.4c-0.6,0-1-0.5-1-1V56.3z"/>
+	<path d="M269.2,54.8c5.7,0,9.9,4.2,9.9,9.9c0,0.4,0,0.9-0.1,1.3c0,0.6-0.5,0.9-1,0.9h-15.9c0.1,3.6,3.2,7.5,7.1,7.5
+		c2.9,0,4.7-1,5.9-1.8c0.8-0.5,1.1-0.7,1.7,0.1l0.6,0.8c0.4,0.7,0.6,0.9-0.2,1.5c-1.3,1-4.2,2.5-8,2.5c-6.6,0-10.6-5.2-10.6-11.4
+		C258.6,60,262.6,54.8,269.2,54.8z M275.6,64.2c-0.1-3.2-2.6-6.2-6.4-6.2c-3.7,0-6.6,2.8-7,6.2H275.6z"/>
+	<path d="M283.6,74.9c-0.2-0.2-0.3-0.6-0.1-0.9l0.7-1.2c0.3-0.5,0.7-0.7,1.3-0.3c0.8,0.6,2.6,1.9,5.4,1.9c2.2,0,3.7-1,3.7-2.7
+		c0-2.1-1.7-2.9-4.9-4.5c-2.9-1.4-6.2-3-6.2-6.7c0-2.3,1.7-5.7,6.8-5.7c2.8,0,5.2,0.9,6.2,1.7c0.5,0.4,0.6,0.8,0.2,1.5l-0.5,0.9
+		c-0.3,0.6-1,0.7-1.5,0.4c-0.9-0.6-2.5-1.3-4.5-1.3c-2.4,0-3.2,1.4-3.2,2.4c0,1.9,1.5,2.6,4.2,3.9c3.8,1.7,7,3.2,7,7.1
+		c0,3.4-3,6.2-7.4,6.2C287.2,77.6,284.8,76,283.6,74.9z"/>
+	<path d="M306,71.3c1.7,0,3.1,1.4,3.1,3.1c0,1.7-1.4,3.2-3.1,3.2c-1.7,0-3.1-1.5-3.1-3.2C302.9,72.7,304.3,71.3,306,71.3z"/>
+	<path d="M318.9,79.4c0,5.9-2.6,8.6-6.2,9.3c-0.5,0.1-0.8-0.1-1-0.6l-0.5-1.4c-0.2-0.7,0.1-1.1,0.7-1.3c2.2-0.8,3.5-2,3.5-5.8V56.3
+		c0-0.6,0.5-1,1-1h1.4c0.5,0,1,0.4,1,1V79.4z M314.5,47.1c0-1.5,1.1-2.6,2.6-2.6c1.4,0,2.5,1.1,2.5,2.6c0,1.4-1.1,2.5-2.5,2.5
+		C315.6,49.6,314.5,48.4,314.5,47.1z"/>
+	<path d="M325.1,74.9c-0.2-0.2-0.3-0.6-0.1-0.9l0.7-1.2c0.3-0.5,0.7-0.7,1.3-0.3c0.8,0.6,2.6,1.9,5.4,1.9c2.2,0,3.7-1,3.7-2.7
+		c0-2.1-1.7-2.9-4.9-4.5c-2.9-1.4-6.2-3-6.2-6.7c0-2.3,1.7-5.7,6.8-5.7c2.8,0,5.2,0.9,6.2,1.7c0.5,0.4,0.6,0.8,0.2,1.5l-0.5,0.9
+		c-0.3,0.6-1,0.7-1.5,0.4c-0.9-0.6-2.5-1.3-4.5-1.3c-2.4,0-3.2,1.4-3.2,2.4c0,1.9,1.5,2.6,4.2,3.9c3.8,1.7,7,3.2,7,7.1
+		c0,3.4-3,6.2-7.4,6.2C328.7,77.6,326.3,76,325.1,74.9z"/>
+</g>
+<g>
+	<circle cx="88.8" cy="57.5" r="2.5"/>
+</g>
+</svg>
