[sling-org-apache-sling-resource-filter] branch master updated: clarified readme.

[jeb]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new d1304cb  clarified readme.
d1304cb is described below

commit d1304cbd24bbfa6709bb33239a0fac69df87c2de
Author: Jason E Bailey <j...@apache.org>
AuthorDate: Wed Aug 29 13:15:32 2018 -0400

    clarified readme.
---
 README.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c304bcd..4249d9f 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
  [![Build 
Status](https://builds.apache.org/buildStatus/icon?job=sling-org-apache-sling-resource-filter-1.8)](https://builds.apache.org/view/S-Z/view/Sling/job/sling-org-apache-sling-resource-filter-1.8)
 [![Test 
Status](https://img.shields.io/jenkins/t/https/builds.apache.org/view/S-Z/view/Sling/job/sling-org-apache-sling-resource-filter-1.8.svg)](https://builds.apache.org/view/S-Z/view/Sling/job/sling-org-apache-sling-resource-filter-1.8/test_results_analyzer/)
 [![License](https://img.s [...]
 
 # Resource Predicate Service
-`ResourcePredicate` is a service takes a simple matching language script that 
allows you to define a `Predicate<Resource>` for use with the Collections and 
the Streams api in Java, it also provides  the ability to add parameters to the 
underlying context that the script will pick up.
+`ResourcePredicate` is a service that allows you to convert a string that 
defines a simple matching requirements and returns a `Predicate<Resource>` for 
use with the Collections and the Streams Java API. In addition it also allows 
you to add parameters to the underlying context that the script will use.
 
 ```java
 @Reference
@@ -16,7 +16,9 @@ resourceCollection.stream().filter(predicate).forEach(
 ```
 
 ## Resource Stream
-`ResourceStream` is a general utility to provide a `Stream<Resource>` which 
traverses a resource and it's subtree. The implementation takes a 
`Predicate<Resource>` object as part of the stream creation to define a branch 
selector that controls which children of a resource are followed
+`ResourceStream` is a general utility to provide a `Stream<Resource>` which 
traverses a resource and it's subtree. The implementation takes a 
`Predicate<Resource>` object as part of the stream creation to define a branch 
selector that controls which children of a resource are followed.
+
+In addition there is a `getChildren(Predicate)` method which returns a 
filtered list of children of the given resource.
 
 
 ## Resource Filter Stream