status-im/sourcecred
2
0
Fork 0
mirror of https://github.com/status-im/sourcecred.git synced 2025-02-05 01:04:53 +00:00
Code Issues Projects Releases Wiki Activity

Demonstrate the GitHub token env var in the README (#556)

Browse Source 
Summary:
Using the environment variable is the preferred way to interact with the
CLI, simply because it’s easier for users. We should demonstrate this
interface instead of the legacy flag-only version.

Paired with @decentralion.

wchargin-branch: readme-env-var
This commit is contained in:
William Chargin 2018-07-27 20:59:54 -07:00 committed by GitHub
parent 68fa7237a0
commit bdb9ae9c46
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -103,7 +103,8 @@ git clone https://github.com/sourcecred/sourcecred.git
cd sourcecred
yarn install
yarn backend
node bin/sourcecred.js load REPO_OWNER REPO_NAME --github-token=GH_TOKEN
export SOURCECRED_GITHUB_TOKEN=YOUR_GITHUB_TOKEN
node bin/sourcecred.js load REPO_OWNER REPO_NAME
# this loads sourcecred data for a particular repository
yarn start
# then navigate to localhost:3000 in your browser
@ -111,9 +112,12 @@ yarn start
For example, if you wanted to look at cred for [ipfs/js-ipfs], you could run:
```
$ node bin/sourcecred.js load ipfs js-ipfs --github-token=YOUR_GH_TOKEN
$ export SOURCECRED_GITHUB_TOKEN=0000000000000000000000000000000000000000
$ node bin/sourcecred.js load ipfs js-ipfs
```
replacing the big string of zeros with your actual token.
[ipfs/js-ipfs]: https://github.com/ipfs/js-ipfs
### Contributing