From 2ece9bf13f8e74460b30e94d2a1394aa236c453c Mon Sep 17 00:00:00 2001
From: Lior Spach <ls12@inf.ufpr.br>
Date: Mon, 31 Aug 2015 09:25:44 -0300
Subject: [PATCH] Update documentation
---
lib/ranking/README.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/lib/ranking/README.md b/lib/ranking/README.md
index 5e1767e3c..a05757ba7 100644
--- a/lib/ranking/README.md
+++ b/lib/ranking/README.md
@@ -1,11 +1,19 @@
# Use Example
-
+### Input :
items = [Item.new("ax",1,1,1,["otherStuffA","lala",'a']),Item.new("bx",2,2,2,[1,2,3,"teste","lblb",'b']),Item.new("cx",1,1,99,[3,2,1,"teste","lclc",'c'])]
+### Rank call :
+
Rater.new.sortByRate(items).each { |i| puts i }
-OR
+
+###### OR
+
Rater.new( # Order of the arguments is important!
positionWeight = 1000,
useWeight = 1,
likeWeight = 100
).sortByRate(items).each { |i| puts i }
+
+
+#### Return (output) :
+ - ordered array of Items, starting from the most ranked to the least
\ No newline at end of file
--
GitLab