Skip to content

Commit

Permalink
Merge pull request #23 from gitcommitshow/gitcommitshow-patch-3
Browse files Browse the repository at this point in the history
readme: fix formatting
  • Loading branch information
gitcommitshow authored Mar 27, 2024
2 parents ab32d6e + 0a7c019 commit 80b2f62
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,23 @@ Tools and stats for open-source communities

[![test](https://github.com/gitcommitshow/open-community-kit/actions/workflows/test.yml/badge.svg)](https://github.com/gitcommitshow/open-community-kit/actions/workflows/test.yml)

# Installation
## Installation

```bash
npm install -g open-community-kit
```

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
(Contributor with highest # of contributions at the top)
## Usage

### Using CLI
### Leaderboard - 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

Expand All @@ -36,7 +39,7 @@ You will hit the API limits soon. **To increase API limits**, add [`GITHUB_PERSO
ock yourGitHubOrgName yourGitHubPersonalToken
```

### Using code
**Using code**

```javascript
import OCK from 'open-community-kit';
Expand All @@ -48,6 +51,8 @@ OCK.contributors.github.archive(
);
```

----

## Settings for repeated usage

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

0 comments on commit 80b2f62

Please sign in to comment.