[sling-whiteboard] branch master updated: Explain the sample better

[bd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bdelacretaz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git


The following commit(s) were added to refs/heads/master by this push:
     new 6a26c03  Explain the sample better
6a26c03 is described below

commit 6a26c03fbfdd00c05d86ab301897bb438581fc43
Author: Bertrand Delacretaz <bd...@apache.org>
AuthorDate: Mon May 17 12:32:08 2021 +0200

    Explain the sample better
---
 remote-content-api/sample-graphql-api/README.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/remote-content-api/sample-graphql-api/README.md b/remote-content-api/sample-graphql-api/README.md
index f1f2a4f..7041383 100644
--- a/remote-content-api/sample-graphql-api/README.md
+++ b/remote-content-api/sample-graphql-api/README.md
@@ -1,5 +1,10 @@
 # Apache Sling Document-Oriented Content API - Sample GraphQL API
 
+This sample provides a GraphQL query and command API that uses the sibling `document-aggregator` module
+to output complete documents that aim to provide everything that's required to render a given Sling resource.
+
+As I write this it doesn't use the SLING-10309 GraphQL pagination features yet, but it should.
+
 To start this, build the sibling modules with `mvn clean install` in the parent folder
 of this one and then, in this folder, run
 
@@ -88,4 +93,4 @@ we don't really care about the details of these node types besides their names.
        {
         path
       }
-    }
\ No newline at end of file
+    }