From 230025b8938382e4cdddb8fa1ceeb8dd22a90840 Mon Sep 17 00:00:00 2001 From: gitcommitshow <56937085+gitcommitshow@users.noreply.github.com> Date: Sun, 17 Mar 2024 18:39:11 +0530 Subject: [PATCH 1/2] docs: code formatting --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c51284..ea17a43 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Tools and stats for open-source communities 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 @@ -56,4 +56,4 @@ If you are going to use this command frequently, you might not want to set organ # Set these variables in the environment to avoid repeatedly specifying these variables 1. REPO_OWNER 2. GITHUB_PERSONAL_TOKEN -``` \ No newline at end of file +``` From 159330fb5e51349b8ab8bc45aab7bd957211e465 Mon Sep 17 00:00:00 2001 From: gitcommitshow <56937085+gitcommitshow@users.noreply.github.com> Date: Fri, 22 Mar 2024 18:20:43 +0530 Subject: [PATCH 2/2] docs: readme formatting --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ea17a43..6d1b84d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Tools and stats for open-source communities # Installation -``` +```bash npm install -g open-community-kit ``` @@ -13,16 +13,16 @@ 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