From 3cb2d45b595ede756b1a4be617358bf50a62e80a Mon Sep 17 00:00:00 2001 From: Yazied Dhiyauddien Date: Tue, 8 Oct 2024 12:06:15 +0700 Subject: [PATCH 1/2] Update README.md - update install command - update example usage Update README.md Update install for different go version Fix readme Add latest version on install instruction --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a6379c..aa19205 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,11 @@ Docker images are also available: `github-download-stats` can be installed from source by running: - go get -u github.com/andrewsomething/github-download-stats +#### Go Version 1.16 and Earlier +`go get -u github.com/andrewsomething/github-download-stats` + +#### Go Version 1.17 and Later +`go install github.com/andrewsomething/github-download-stats@latest` ## Usage @@ -33,6 +37,18 @@ Usage of ./github-download-stats: -version Print version ``` +### Usage for Get Stats for All Releases +``` +github-download-stats -owner -repo -token +``` +### Usage for Get Stats for Spesific Releases +``` +github-download-stats -owner -repo -release -token +``` +### Usage for Get Stats in JSON +``` +github-download-stats -owner -repo -json -token +``` ## License From d3043ab6ad94c66e9a04bcbcdb74231e8b6de203 Mon Sep 17 00:00:00 2001 From: Andrew Starr-Bochicchio Date: Sun, 20 Oct 2024 17:17:49 -0400 Subject: [PATCH 2/2] Use full code blocks. --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aa19205..03a07ae 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,16 @@ Docker images are also available: `github-download-stats` can be installed from source by running: #### Go Version 1.16 and Earlier -`go get -u github.com/andrewsomething/github-download-stats` + +``` +go get -u github.com/andrewsomething/github-download-stats +``` #### Go Version 1.17 and Later -`go install github.com/andrewsomething/github-download-stats@latest` + +``` +go install github.com/andrewsomething/github-download-stats@latest +``` ## Usage @@ -38,14 +44,17 @@ Usage of ./github-download-stats: Print version ``` ### Usage for Get Stats for All Releases + ``` github-download-stats -owner -repo -token ``` -### Usage for Get Stats for Spesific Releases +### Usage for Get Stats for Specific Releases + ``` github-download-stats -owner -repo -release -token ``` ### Usage for Get Stats in JSON + ``` github-download-stats -owner -repo -json -token ```