diff --git a/README.md b/README.md index 5a68db4..ea6ed92 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,24 @@ Tools and stats for open-source communities # Installation -``` +```bash npm install -g open-community-kit ``` -You can use npx as well if you just want to test a CLI command +You can use `npx` as well if you just want to test a CLI command # Usage -## Create a leaderboard of github contributors for all the repos of a user/org +## Create a leaderboard of Github contributors for all the repos of a user/org (Contributor with highest # of contributions at the top) ### Using CLI Run `open-community-kit yourGithubOrgName` from your terminal -Note: You can also use the shorthand `ock` in place of `open-commmunity-kit` i.e. +Note: You can also use the shorthand `ock` in place of `open-community-kit` i.e. -``` +```bash ock yourGitHubOrgName ``` @@ -32,7 +32,7 @@ This will You will hit the API limits soon. **To increase API limits**, add [`GITHUB_PERSONAL_TOKEN`](https://github.com/settings/tokens) as well in the arguments i.e. -``` +```bash ock yourGitHubOrgName yourGitHubPersonalToken ``` @@ -52,7 +52,7 @@ OCK.contributors.github.archive( If you are going to use this command frequently, you might not want to set organization name and personal token again and again. Instead, you can set following environment variables and then you don't need to pass those variables as CLI arguments or function parameters -``` +```yaml # Set these variables in the environment to avoid repeatedly specifying these variables 1. REPO_OWNER 2. GITHUB_PERSONAL_TOKEN