Skip to content

Commit

Permalink
update readme for #15
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed Nov 18, 2024
1 parent 50b5c88 commit 17b92a8
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 10 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: allcontributors
Title: Acknowledge all Contributors to a Project
Version: 0.2.2.006
Version: 0.2.2.007
Authors@R: c(
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre")),
person("Chris", "Hartgerink", role = "aut"),
Expand Down
15 changes: 12 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ everything the original does, but it makes what it does much easier.
The original [`allcontributors.org`](https://allcontributors.org/) is primarily
a bot which responds to commit messages such as `add @user for <contribution>`,
where `<contribution>` is one of the [recognized
types](https://allcontributors.org/docs/en/emoji-key). As said above, the
relative advantage of that original system lies primarily in the diversity of
types](https://allcontributors.org/docs/en/emoji-key). One
advantage of the original system is the diversity of
contribution types able to be acknowledged, with each type for a given user
appearing as a corresponding
[emoji](https://allcontributors.org/docs/en/emoji-key) below their github
Expand All @@ -67,6 +67,12 @@ avatar as listed on the README. In comparison, this R package:
numbered lists of github user names only, or single text strings of
comma-separated names.

This ease of automation means you can easily update your contributors list with
a [simple GitHub
workflow](https://github.com/ropensci/allcontributors/blob/main/.github/workflows/allcontributors.yml),
set to update at some regular interval. Your contributor list will then be kept
up-to-date without you having to remember or do anything.

## Installation

The package is on CRAN, and can be installed with,
Expand Down Expand Up @@ -185,7 +191,10 @@ This can be used to change the formats of acknowledgements at any time. If
anything goes wrong, the easiest way to replace a contributions section is to
simply delete the old ones from all files, and call
[`add_contributors()`](https://docs.ropensci.org/allcontributors/reference/add_contributors.html)
again.
again. This package also includes a [GitHub workflow
file](https://github.com/ropensci/allcontributors/blob/main/.github/workflows/allcontributors.yml)
which you can simply copy and add to your own repository, and your
"allcontributors" section will be automatically updated at regular intervals.

## More Information

Expand Down
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,9 @@ original does, but it makes what it does much easier.
The original [`allcontributors.org`](https://allcontributors.org/) is
primarily a bot which responds to commit messages such as
`add @user for <contribution>`, where `<contribution>` is one of the
[recognized types](https://allcontributors.org/docs/en/emoji-key). As
said above, the relative advantage of that original system lies
primarily in the diversity of contribution types able to be
acknowledged, with each type for a given user appearing as a
[recognized types](https://allcontributors.org/docs/en/emoji-key). One
advantage of the original system is the diversity of contribution types
able to be acknowledged, with each type for a given user appearing as a
corresponding [emoji](https://allcontributors.org/docs/en/emoji-key)
below their github avatar as listed on the README. In comparison, this R
package:
Expand All @@ -47,6 +46,12 @@ package:
numbered lists of github user names only, or single text strings
of comma-separated names.

This ease of automation means you can easily update your contributors
list with a [simple GitHub
workflow](https://github.com/ropensci/allcontributors/blob/main/.github/workflows/allcontributors.yml),
set to update at some regular interval. Your contributor list will then
be kept up-to-date without you having to remember or do anything.

## Installation

The package is on CRAN, and can be installed with,
Expand Down Expand Up @@ -168,7 +173,11 @@ acknowledgements at any time. If anything goes wrong, the easiest way to
replace a contributions section is to simply delete the old ones from
all files, and call
[`add_contributors()`](https://docs.ropensci.org/allcontributors/reference/add_contributors.html)
again.
again. This package also includes a [GitHub workflow
file](https://github.com/ropensci/allcontributors/blob/main/.github/workflows/allcontributors.yml)
which you can simply copy and add to your own repository, and your
“allcontributors” section will be automatically updated at regular
intervals.

## More Information

Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"codeRepository": "https://github.com/ropensci/allcontributors",
"issueTracker": "https://github.com/ropensci/allcontributors/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.2.2.006",
"version": "0.2.2.007",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down

0 comments on commit 17b92a8

Please sign in to comment.