From 5e12dd7eff6cc0f67d4ef8b36754064618e85f3f Mon Sep 17 00:00:00 2001
From: moklick <info@moritzklack.com>
Date: Tue, 21 Jul 2020 10:48:52 +0200
Subject: [PATCH] docs(readme): add getOutgoers function, explain
 removeElements closes #349

---
 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d5b463e2..e87a9af2 100644
--- a/README.md
+++ b/README.md
@@ -482,7 +482,7 @@ Returns true if element is a node
 
 ### removeElements
 
-Returns elements without the elements from `elementsToRemove`
+Returns an array of elements without the ones from `elementsToRemove`. It also removes all incoming/outgoing edges if you just pass one or multiple nodes
 
 `removeElements = (elementsToRemove: Elements, elements: Elements): Elements`
 
@@ -492,6 +492,12 @@ Returns elements array with added edge
 
 `addEdge = (edgeParams: Edge, elements: Elements): Elements`
 
+### getOutgoers
+
+Returns all direct child nodes of the passed node
+
+`getOutgoers = (node: Node, elements: Elements): Node[]`
+
 
 You can use these function as seen in [this example](/example/src/Overview/index.js#L40-L41) or use your own ones.