added readme convenience script

package.json

@@ -32,7 +32,8 @@
     "export-schema": "node ./scripts/construct.js",
     "export-migration": "node ./scripts/migrate.js",
     "export-rollback": "node ./scripts/rollback.js",
-    "tsc": "tsc --noEmit types.d.ts"
+    "tsc": "tsc --noEmit types.d.ts",
+    "readme": "node ./test/readme.js"
   },
   "mocha": {
     "timeout": 10000,

test/readme.js

@@ -0,0 +1,26 @@
+const helper = require('./testHelper')
+
+async function readme () {
+  const PgBoss = require('../src')
+  const boss = new PgBoss(helper.getConnectionString())
+
+  boss.on('error', error => {
+    console.error(error)
+  })
+
+  await boss.start()
+
+  const queue = 'some-queue'
+
+  await boss.schedule(queue, '* * * * *')
+
+  console.log(`created cronjob in queue ${queue}`)
+
+  await boss.work(queue, someAsyncJobHandler)
+}
+
+async function someAsyncJobHandler (job) {
+  console.log(`running job ${job.id}`)
+}
+
+readme()