Skip to content

Commit

Permalink
Merge pull request #20 from gitcommitshow/gitcommitshow-patch-2
Browse files Browse the repository at this point in the history
docs: code formatting
  • Loading branch information
gitcommitshow authored Mar 23, 2024
2 parents bb99fe1 + 159330f commit ab32d6e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
```

Expand All @@ -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
Expand Down

0 comments on commit ab32d6e

Please sign in to comment.