diff --git a/README.md b/README.md index a63887d..3e82d42 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,28 @@ Tokenize github repositories by commits and issues. Accept donations in eth toke ## Usage -### User Registration -Create a gist in your github containing in it's body only an ethereum address you own. -Must be in first line with no spaces and no more lines. -Call `GitHubOracle.register("","")` -Example: `GitHubOracle.register("3esmit","31a58f2ddf2258697cce1b969e7c298b")` +## User Registration +Create a gist in your github containing in it's body only an ethereum address you own. +Must be in first line with no spaces and no more lines. +Call `DGit.register("","")` (oracle cost ~0.06 USD) +Example: `DGit.register("3esmit","31a58f2ddf2258697cce1b969e7c298b")` -### Repository Registration -Call `GitHubOracle.addRepository("/")` -Example: `GitHubOracle.addRepository("ethereans/github-token")` +## Repository +Call `DGit.addRepository("/")` (oracle cost ~0.06 USD) +Example: `DGit.addRepository("status-im/github-oracle")` -### Claiming Tokens -Push your commits to github and take the github commitid for each push. -Call `GitHubOracle.claimCommit("")` -Example: `GitHubOracle.claimCommit("0d3a00941ed72a89f1bf273f17cfd12a0790b82d")` -There is no need of specifing the user, this is returned by oraclize call, but the user need to be registered in GitHubOracle in order to claim the tokens. -Anyone can call this, and the tokens will be sent to the address registered in user registry. +### Tokenize Contributions +Push your commits to GitHub and simply call `DGit.updateCommits("/")` +This call will cost $0.54 USD and can process up to 4000 commits. +Call `DGit.continueCommits("/")` (oracle cost ~0.54 USD) +Example: `DGit.updateCommits("status-im/github-oracle")` -### Withdraw donations -When contract enters in lock period just call `GitHubToken.withdraw()` to get your share of the donations. - -### Testing in ethereum-studio -This project was created using ethereum-studio. It contains ethereum.json and scenarios. -Simply clone it in your workspace and you are ready to go. +### Bounty issue +When you start an issue at GitHub, you can bounty it. First you need to open it: +Call `DGit.openBounty("/",)` (oracle cost ~0.06 USD) +This will enable people to bounty into this issue, this call can contain itself a bounty to be added. +When issue is finalized call `DGit.updateIssue("/",)` (oracle cost ~0.54 USD) +This will tokenize the commits of pull requests cross-referenced with this issue and, after a lock period, distribute a fair share of bounty between contributors. + +### Withdraw donations +When contract enters in lock period just call `GitHubToken.withdraw()` to get your share of the donations.