From 7f7c9217d8f91cb4b95cb13423cd2517a380dc51 Mon Sep 17 00:00:00 2001 From: balasan Date: Fri, 2 Apr 2021 19:12:18 -0400 Subject: [PATCH] docs --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 5d123fa..aeaf105 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ detrep (deterministic version): [![GoDoc](https://godoc.org/github.com/relevant- Relevant Reputation Protocol is a personalized pagerank algorithm that supports negative links. It is used to compute user and content rankings in a reddit-like bulletin board — [Relevant](https://relevant.community). +Disclaimer: The code in this repo has not be audited or tested in production, please use at your own risk. + ## Use Cases Because the algorithm supports negative links, it can be used to represent upvotes and downvotes. This enables usescases such as voting, governance and ranking of data. @@ -18,6 +20,10 @@ The deterministiv version of the algorithm uses `Uint` and safe-math libs from [ ## Usage +For complete usage examples, check out the test files: https://github.com/relevant-community/reputation/blob/main/rep/pagerank_test.go and https://github.com/relevant-community/reputation/blob/main/detrep/pagerank_test.go + +As well as the R3l Cosmos App (WIP): https://github.com/relevant-community/r3l/blob/main/cmd/r3ld/cmd/worker/computeRep.go + ### Step 1. Import the Package and Initialize the Graph ```go