From 8e800eb13c1aac31cb8aca034979bb9ab54aa908 Mon Sep 17 00:00:00 2001
From: toniher <toniher@cau.cat>
Date: Thu, 20 Oct 2016 16:06:54 +0200
Subject: [PATCH] update READMEE a bit

---
 README.md | 37 ++++++++++++++++++++++++-------------
 1 file changed, 24 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 8ed304c..ae2fd46 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # SMWParent
 
-Extension for printing out ancestors and descendants of a certain page-based on interconnected Semantic MediaWiki properties.
+Extension for printing out ancestors, descendants and relationship trees of pages interconnected with Semantic MediaWiki properties.
 
 ## Functions 
 
@@ -10,6 +10,27 @@ Extension for printing out ancestors and descendants of a certain page-based on
 * {{#SMWChildren:}}
   Show the children / descendant pages
 
+### Usage
+
+* {{#SMWParent:FULLPAGENAME|PARENT_TYPE/PARENT_LEVEL|link}}
+
+
+Params:
+
+- If FULLPAGENAME is skipped, current page is used
+- PARENT_TYPE to retrieve, or alternately up to which level PARENT_LEVEL to reach
+- If input is 'link', resulting pages are shown as links instead of as text.
+
+## API
+
+An API endpoint is available. action=smwparent.
+* retrieve: 3 possible methods (parent, children, tree)
+* title: fullpage title of page in the wiki
+* type: the type of pages to be retrieved (according to a given properties)
+* link_properties: properties used for linking between pages
+* type_properties: properties used for defining the types. If 'Categories', MediaWiki categories are also used.
+* print_properties: properties to be printed and appended to the nodes.
+
 ## Parameters and default values
 
 You can override these values by modifying LocalSettings.php below extension requirement.
@@ -26,18 +47,8 @@ $wgSMWParentProps = array('Comes_from_Process', 'Comes_from_Sample', 'Has_Reques
 
 $wgSMWParentPrintProps = array('Start', 'End'); // Properties associated to an object which are printed
 
-## Usage
-
-* {{#SMWParent:FULLPAGENAME|PARENT_TYPE/PARENT_LEVEL|link}}
-
-Params:
-
-- If FULLPAGENAME is skipped, current page is used
-- PARENT_TYPE to retrieve, or alternately up to which level PARENT_LEVEL to reach
-- If input is 'link', resulting pages are shown as links instead of as text.
-
 ## TODO
 
-* Producing a full tree from parent and children outputs
-* Design API
 * Better handling of SMW property types
+* Refactor some functions and variables
+