Skip to content

Commit 159330f

Browse files
docs: readme formatting
1 parent 230025b commit 159330f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@ Tools and stats for open-source communities
55

66
# Installation
77

8-
```
8+
```bash
99
npm install -g open-community-kit
1010
```
1111

1212
You can use `npx` as well if you just want to test a CLI command
1313

1414
# Usage
1515

16-
## Create a leaderboard of github contributors for all the repos of a user/org
16+
## Create a leaderboard of Github contributors for all the repos of a user/org
1717
(Contributor with highest # of contributions at the top)
1818

1919
### Using CLI
2020

2121
Run `open-community-kit yourGithubOrgName` from your terminal
2222

23-
Note: You can also use the shorthand `ock` in place of `open-commmunity-kit` i.e.
23+
Note: You can also use the shorthand `ock` in place of `open-community-kit` i.e.
2424

25-
```
25+
```bash
2626
ock yourGitHubOrgName
2727
```
2828

@@ -32,7 +32,7 @@ This will
3232

3333
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.
3434

35-
```
35+
```bash
3636
ock yourGitHubOrgName yourGitHubPersonalToken
3737
```
3838

@@ -52,7 +52,7 @@ OCK.contributors.github.archive(
5252

5353
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
5454

55-
```
55+
```yaml
5656
# Set these variables in the environment to avoid repeatedly specifying these variables
5757
1. REPO_OWNER
5858
2. GITHUB_PERSONAL_TOKEN

0 commit comments

Comments
 (0)