doc: improve Readme

Author: madeindjs

README.md

@@ -15,7 +15,7 @@ Why you should prefer Graphile Worker instead of [Bull](https://github.com/nestj
 
 ## Features
 
-- use a `GraphileWorkerModule.forRoot` to register Graphile Worker (support `asRootAsync` as well)
+- provide a module `GraphileWorkerModule` to setup the runner using `asRoot` or `asRootAsync`
 - provide a `WorkerService` to add jobs or start runner
 - provide a `@OnWorkerEvent` decorator to add custom behavior on `job:success` for example
 - provide a `@Task(name)` decorator to define your injectable tasks
@@ -24,13 +24,17 @@ Why you should prefer Graphile Worker instead of [Bull](https://github.com/nestj
 
 ```sh
 npm install nestjs-graphile-worker
+yarn add nestjs-graphile-worker
+pnpm add nestjs-graphile-worker
 ```
 
 ## Usage
 
-### Import module
+### 1. Setup the module
 
-You can use `GraphileWorkerModule.forRoot`:
+In order, to setup the library, you need to import and initialize [`GraphileWorkerModule`](./src/graphile-worker.module.ts).
+
+You can do it using `forRoot` method:
 
 ```ts
 // src/app.module.ts
@@ -50,9 +54,10 @@ import { AppController } from "./app.controller";
 export class AppModule {}
 ```
 
-Or you can use `GraphileWorkerModule.forRootAsync`:
+Or using `forRootAsync`:
 
 ```ts
+// src/app.module.ts
 import { GraphileWorkerModule } from "nestjs-graphile-worker";
 import { Module } from "@nestjs/common";
 import { ConfigModule, ConfigService } from "@nestjs/config";
@@ -79,11 +84,37 @@ import { helloTask } from "./hello.task";
 export class AppModule {}
 ```
 
-## Create task
+The module configuration is [`GraphileWorkerConfiguration`](./src/interfaces/module-config.interfaces.ts), which is a wrapper around Graphile's [`RunnerOptions`](https://github.com/graphile/worker/blob/7feecdde5692569f006d3379f4caee01c4482707/src/interfaces.ts#L716)
+
+```ts
+type GraphileWorkerConfiguration = Omit<RunnerOptions, "events" | "taskList">;
+```
+
+This means you can pass any configuration to the runner, like [Recurring tasks (crontab)](https://worker.graphile.org/docs/cron):
+
+```ts
+// src/app.module.ts
+@Module({
+  imports: [
+    GraphileWorkerModule.forRoot({
+      connectionString: "postgres://example:password@postgres/example",
+      crontab: [' * * * * * taskIdentifier ?priority=1 {"foo": "bar"}'].join(
+        "\n",
+      ),
+    }),
+  ],
+  controllers: [AppController],
+  providers: [],
+})
+export class AppModule {}
+```
+
+### 2. Create task
 
-To create task you need to define an `@Injectable` class with `@Task(name)` decorator who contains a decorated method `@TaskHandler`:
+To create task you need to define an `@Injectable` class with `@Task(name)` decorator containing a decorated method with `@TaskHandler`:
 
 ```ts
+// src/hello.task.ts
 import { Injectable, Logger } from "@nestjs/common";
 import type { Helpers } from "graphile-worker";
 import { Task, TaskHandler } from "../../src/index";
@@ -103,6 +134,7 @@ export class HelloTask {
 Then do not forget to register this class as provider in your module:
 
 ```ts
+// src/app.module.ts
 import { Module } from "@nestjs/common";
 import { HelloTask } from "./hello.task";
 // ...
@@ -119,9 +151,9 @@ import { HelloTask } from "./hello.task";
 export class AppModule {}
 ```
 
-## Create jobs
+### 3. Create jobs
 
-You may use `WorkerService`:
+You can use [`WorkerService`](./src/services/worker.service.ts) which is a wrapper of [`graphile-worker`](graphile-worker)'s [`Runner`](https://worker.graphile.org/docs/library/run#runner) instance. [`WorkerService`](./src/services/worker.service.ts) let you add job easily.
 
 ```ts
 import { WorkerService } from "nestjs-graphile-worker";
@@ -149,9 +181,9 @@ export class AppController {
 }
 ```
 
-## Start runner
+### 4. Start runner
 
-Add `WorkerService.run` in `main.ts` file:
+Add [`WorkerService.run`](https://github.com/madeindjs/nestjs-graphile-worker/blob/7ed5a99dcd28a11259031e0e738b0cf5a4050904/src/services/worker.service.ts#L31-L42) in `main.ts` file:
 
 ```ts
 import { WorkerService } from "nestjs-graphile-worker";
@@ -166,11 +198,12 @@ async function bootstrap() {
 bootstrap();
 ```
 
-## `OnWorkerEvent` decorator
+### 5. Listen any Graphile's event
 
-This decorator allow you to listen all [Graphile Worker event](https://github.com/graphile/worker#workerevents)
+You can use `@OnWorkerEvent` decorator to listen any [Graphile Worker event](https://worker.graphile.org/docs/worker-events). You simply have to:
 
-You need to add `@GraphileWorkerListener` decorator on your class and then set `@OnWorkerEvent(eventName)` on method:
+1. `@GraphileWorkerListener` decorator on your class
+2. set `@OnWorkerEvent(eventName)` on your method
 
 ```ts
 import { Injectable, Logger } from "@nestjs/common";
@@ -194,19 +227,9 @@ export class AppService {
 }
 ```
 
-## Test
-
-```bash
-# unit tests
-$ npm run test
-
-# test coverage
-$ npm run test:cov
-```
-
-# Sample
+## Sample
 
-You can find a [sample](./sample/) who use library. To run it, simply `npm install` and then:
+You can find a [sample](./sample/) using this library. To run it, simply `npm install` and then:
 
 ```sh
 docker-compose up