Skip to content

Commit 76661cd

Browse files
authored
Merge pull request #73 from r-multiverse/169
Suggest installation instructions in contributors.md
2 parents 9b88917 + 14c9720 commit 76661cd

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

contributors.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,12 @@ To add a dynamic 'R-multiverse' badge for package readme files, like the one abo
112112
[![R-multiverse status](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fcommunity.r-multiverse.org%2Fapi%2Fpackages%2FpkgNAME&query=%24.Version&label=r-multiverse)](https://community.r-multiverse.org/pkgNAME)
113113
```
114114

115+
## Installation instructions
116+
117+
In the `README` of your package, it is good practice to include installation instructions ([example](https://github.com/pola-rs/r-polars/blob/main/README.md#install)).
118+
Please see the [overview page](https://r-multiverse.org/overview.html#installing-packages) for general instructions on installing packages from R-multiverse.
119+
Feel free to adapt these instructions for your own package.
120+
115121
## Deregistration
116122

117123
If it becomes necessary to deregister a package from R-multiverse, you may submit a

0 commit comments

Comments
 (0)