From eddee79c573d9a94178e356656215a26d2f435c7 Mon Sep 17 00:00:00 2001
From: Stuart Clark <stuart@realityloop.com>
Date: Fri, 25 Sep 2020 11:40:17 +1000
Subject: [PATCH] [#1] Added README.md.

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bcb23a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# JSON:API Views
+
+> Creates [JSON:API Resource](https://www.drupal.org/project/jsonapi_resources) for [Views](https://www.drupal.org/docs/8/core/modules/views).
+
+Entities resulting from a view query will be available at `/jsonapi/views/{view_id}/{display}`.
+
+This endpoint should respect any exposed filter parameters configured for a display.
+
+
+## Why would you ever want to do that?
+
+This is useful in cases where you have multiple displays of a single view that share the same exposed filters, some of which are decoupled. This will allow the decoupled portions to limit their concerns to just displaying the resulting resources and gives site admins some flexibility in configuring their exposed filters.