Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
balasan committed Apr 2, 2021
1 parent 794a913 commit 7f7c921
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 7f7c921

Please sign in to comment.