feat: support using this plugin multiple times (#5)

Author: benjie

.gitignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -2,12 +2,16 @@
 
 This Graphile Engine plugin can be used to give your schema support for
 "soft-deletes" - where you set an `is_archived` or `is_deleted` column to true
-and expect the record to be omitted by default (but it's still available to
-be recovered should you need to).
+and expect the record to be omitted by default (but it's still available to be
+recovered should you need to). It's also useful for hiding certain other classes
+of records by default, but allowing them to be shown by passing a parameter.
+
+It's possible to use this plugin multiple times (for different column
+names/meanings).
 
 ## Installing
 
-This requires `postgraphile@^4.0.1`
+This requires `postgraphile@^4.5.5`.
 
 ```
 yarn add postgraphile @graphile-contrib/pg-omit-archived
@@ -36,7 +40,8 @@ postgraphile --append-plugins @graphile-contrib/pg-omit-archived -c postgres:///
 
 ### Usage - Library
 
-You can modify the archived column name when using PostGraphile as a library, e.g.:
+You can modify the archived column name when using PostGraphile as a library,
+e.g.:
 
 ```js
 const express = require("express");
@@ -53,7 +58,36 @@ app.use(
       pgArchivedColumnName: "is_archived",
     },
     /* ☝️☝️☝️ */
-  })
+  }),
+);
+
+app.listen(process.env.PORT || 3000);
+```
+
+You can also use the plugin multiple times for different columns, for example:
+
+```js
+const express = require("express");
+const { postgraphile } = require("postgraphile");
+const PgOmitArchived = require("@graphile-contrib/pg-omit-archived");
+
+const app = express();
+
+app.use(
+  postgraphile(process.env.DATABASE_URL, "app_public", {
+    /* 👇👇👇 */
+    appendPlugins: [
+      PgOmitArchived.custom("archived"),
+      PgOmitArchived.custom("deleted"),
+      PgOmitArchived.custom("template"),
+    ],
+    graphileBuildOptions: {
+      pgArchivedColumnName: "is_archived", // boolean column -> checked as "IS NOT TRUE"
+      pgDeletedColumnName: "deleted_at", // non-boolean column -> checked as "IS NULL"
+      pgTemplateColumnName: "is_template",
+    },
+    /* ☝️☝️☝️ */
+  }),
 );
 
 app.listen(process.env.PORT || 3000);
@@ -63,25 +97,26 @@ app.listen(process.env.PORT || 3000);
 
 Root level query fields will omit archived records by default.
 
-Plural relation fields on an object will by default be set to INHERIT, which
+Plural relation fields on an object will by default be set to `INHERIT`, which
 means that if the parent record is archived then all child records will be
-included; otherwise (if the parent record is NOT archived) only the
+included; otherwise (if the parent record is _NOT_ archived) only the
 non-archived child records will be available.
 
 Singular relations and lookups ignore the `is_archived` column - it's assumed
 that if you know the exact ID then you're deliberately opting to view the
 archived record.
 
 This plugin **does not** prevent people from seeing archived records, it merely
-prevents them being included _by default_ by various collections so you must
-opt to see archived content.
+prevents them being included _by default_ by various collections so you must opt
+to see the excluded content.
 
 ## Assumptions
 
-It's assumed that if a record is archived then all of its children should also
-be archived. We don't actually care if this is the case or not, and will work
-regardless, but it's an assumption that we have.
+It's assumed that if a record is archived then all of its children will also be
+archived. We don't actually care if this is the case or not, and will work
+regardless, but it's an assumption that we have. It's up to you to enforce this
+if it makes sense to do so ─ database triggers are a good solution to this.
 
 ## Thanks
 
-🙏 This plugin was sponsored by https://sprout.io
+🙏 This plugin was sponsored by https://sprout.io and is used in production.