From c007701879063fabdc80257b4a4d756a61a7c237 Mon Sep 17 00:00:00 2001 From: mpadge Date: Thu, 12 Dec 2024 14:47:22 +0100 Subject: [PATCH] more readme --- DESCRIPTION | 2 +- README.md | 38 ++++++++++++++++++++++++++++++++++++++ codemeta.json | 2 +- 3 files changed, 40 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 8d2e067..cc3f0e7 100755 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: repometrics Title: Metrics for Your Code Repository -Version: 0.1.3.018 +Version: 0.1.3.019 Authors@R: person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-2172-5265")) diff --git a/README.md b/README.md index 123a037..e1b9f31 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,44 @@ from commit histories and GitHub interactions, converts it all to standardised metrics, and displays the result as a single, interactive dashboard of your repository. +## How? + +### Installation + +First, install the package either via [`r-universe`](https://r-universe.dev): + +``` r +options (repos = c ( + ropenscireviewtools = "https://ropensci-review-tools.r-universe.dev", + CRAN = "https://cloud.r-project.org" +)) +install.packages ("repometrics") +``` +or directly from GitHub with one of these two lines: + +``` r +remotes::install_github ("ropensci-review-tools/repometrics") +pak::pkg_install ("ropensci-review-tools/repometrics") +``` + +### Use + +The main data-gathering function requires just one parameter specifying the +path to a local source repository: + +``` r +data <- repometrics_data_pkg (path) +``` + +The results can then be visualised as an interactive dashboard by running this +line: + +``` r +repometrics_dashboard (data) +``` + +The dashboard will automatically open in your default browser. + ## Prior Art There are lots of tools for collating metrics of software repositories, most of diff --git a/codemeta.json b/codemeta.json index b59931c..dc17ff4 100644 --- a/codemeta.json +++ b/codemeta.json @@ -8,7 +8,7 @@ "codeRepository": "https://github.com/ropensci-review-tools/repometrics", "issueTracker": "https://github.com/ropensci-review-tools/repometrics/issues", "license": "https://spdx.org/licenses/GPL-3.0", - "version": "0.1.3.018", + "version": "0.1.3.019", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R",