Skip to content

Commit 1ffb379

Browse files
authored
Update README.md (#138)
1 parent 4dd6463 commit 1ffb379

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,18 +103,23 @@ access your Discord server, you need to generate a "bot token" and paste it in t
103103
The full instructions for setting up the Discord plugin can be found in the [Discord plugin page](https://sourcecred.io/docs/beta/plugins/discord/#configuration)
104104
in the SourceCred documentation.
105105

106-
## Step 3: Configure PageRank Weights
107-
Our current core algorithm is a variation of an algorithm called PageRank. This is a graph-based algorithm that requires weights to be set for the nodes and edges. We provide default weights, and if you want, you can skip this section for now. When you're ready to decide for yourself how Cred should flow through the graph, follow these instructions:
106+
## Step 3: Configure CredRank Weights
107+
Our current core algorithm, CredRank, is a variation of an algorithm called PageRank. This is a graph-based algorithm that requires weights to be set for the nodes and edges. We provide default weights, and if you want, you can skip this section for now. When you're ready to decide for yourself how Cred should flow through the graph, follow these instructions:
108108
1. Run `yarn sourcecred serve`, open `localhost:6006` in a browser, and navigate to the Weight Configuration page.
109109
1. Set the node and edge weights for each plugin. See [this guide](https://sourcecred.io/docs/beta/cred#choosing-weights) and the [plugin docs](https://sourcecred.io/docs/beta/plugins/github/) for help.
110110
1. Click "Download weights", move the downloaded file from your downloads folder to the `config/` folder in your instance, and then make sure the name is exactly `weights.json`
111111

112+
## Step 3 (alternative): Configure our experimental algorithm CredEquate
113+
For a comparison of the two available algorithms, and example configs, see: https://sourcecred.io/docs/guides/core-algorithm/
114+
112115
## Step 4: Configure Dependency Cred
113116

114117
In `config/dependencies.json` you'll notice there is a default configuration for recognizing SourceCred as a dependency that powers your community. This will create bonus Cred and give it to an identity named `sourcecred`, which will be activated to receive rewards. By default it is set to 0.05 (5% of minted Cred).
115118

116119
If you choose to keep or increase our dependency cred, rewards distributed to our community support the longevity and development of the project. If you are interested in possibly getting extra tech support or feature prioritization for higher depencency cred, reach out on [Discord](https://sourcecred.io/discord) in our _#any-questions_ channel! If you want to lower or remove the dependency cred, we're dedicated to open source and you totally can.
117120

121+
NOTE: WE ARE NO LONGER ACCEPTING REWARDS/DONATIONS AT THIS TIME
122+
118123
## Step 5: Test with the CLI
119124

120125
Use the following commands to run your instance locally:
@@ -191,6 +196,9 @@ Below is an example `grain.json` file for a configuration that uses a combinatio
191196
}
192197
```
193198

199+
### Optionally use our CSV Grain Integration
200+
Instead of doing Grain balance accounting in SourceCred, you can instead make Grain distributions output CSV files to directly send payouts to participants using Disperse.app or Gnosis Safe CSV app. To try this out, see: https://sourcecred.io/docs/guides/csv-grain/
201+
194202
## That's it!
195203
You've set up a SourceCred instance! We'd love to know you're out there. _**Introduce yourself and link your repository**_ on our [Discord](https://sourcecred.io/discord) or @ us on [Twitter](https://twitter.com/sourcecred).
196204

0 commit comments

Comments
 (0)