Skip to content

Commit

Permalink
Touch up README
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Dec 7, 2023
1 parent 321214a commit 265808a
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 47 deletions.
14 changes: 6 additions & 8 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,7 @@ knitr::opts_chunk$set(


<!-- badges: start -->
[![R build
status](https://github.com/coatless/ghapi3/workflows/R-CMD-check/badge.svg)](https://github.com/coatless/ghapi3/actions)
[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/ghapi3)](http://www.r-pkg.org/pkg/ghapi3)
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/ghapi3)](https://cran.r-project.org/package=ghapi3)
[![Coverage Status](https://img.shields.io/codecov/c/github/coatless/ghapi3/master.svg)](https://codecov.io/github/coatless/ghapi3?branch=master)
[![R-CMD-check](https://github.com/coatless-rpkg/ghapi3/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/ghapi3/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## ghapi3
Expand All @@ -31,16 +27,18 @@ access the GitHub API's methods.

You can install `ghapi3` from github with:

```{r gh-installation, eval = FALSE}
```r
if(!requireNamespace("remotes", quietly = TRUE)) { install.packages("remotes") }
remotes::install_github("coatless/ghapi3")
remotes::install_github("coatless-rpkg/ghapi3")
```

### Implementation

We have support presently for:

```{r, echo = FALSE}
```{r}
#| echo: false
# Must be in the environment...
library("ghapi3")
Expand Down
71 changes: 32 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,8 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

<!-- badges: start -->

[![R build
status](https://github.com/coatless/ghapi3/workflows/R-CMD-check/badge.svg)](https://github.com/coatless/ghapi3/actions)
[![CRAN RStudio mirror
downloads](http://cranlogs.r-pkg.org/badges/ghapi3)](http://www.r-pkg.org/pkg/ghapi3)
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/ghapi3)](https://cran.r-project.org/package=ghapi3)
[![Coverage
Status](https://img.shields.io/codecov/c/github/coatless/ghapi3/master.svg)](https://codecov.io/github/coatless/ghapi3?branch=master)
[![R-CMD-check](https://github.com/coatless-rpkg/ghapi3/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/ghapi3/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

## ghapi3
Expand All @@ -24,43 +17,43 @@ You can install `ghapi3` from github with:

``` r
if(!requireNamespace("remotes", quietly = TRUE)) { install.packages("remotes") }
remotes::install_github("coatless/ghapi3")
remotes::install_github("coatless-rpkg/ghapi3")
```

### Implementation

We have support presently for:

| Implemented Functions |
| :------------------------------ |
| add\_collaborator |
| add\_org\_member |
| add\_org\_team\_member |
| browse\_commit\_diff |
| check\_org\_private\_membership |
| check\_org\_public\_membership |
| create\_org\_invitation\_email |
| create\_org\_invitation\_ghname |
| create\_org\_repo |
| create\_tag |
| create\_url\_commit\_diff |
| create\_user\_repo |
| get\_collaborator\_list |
| get\_contributors\_list |
| get\_emoji\_list |
| get\_org\_invitations |
| get\_org\_members\_list |
| get\_org\_repos\_list |
| get\_org\_team\_details |
| get\_org\_team\_invitations |
| get\_org\_teams\_list |
| get\_self\_repos\_list |
| get\_user\_repos\_list |
| remove\_collaborator |
| remove\_org\_member |
| remove\_org\_team\_member |
| transfer\_repo |
| update\_org\_member\_role |
| Implemented Functions |
|:-----------------------------|
| add_collaborator |
| add_org_member |
| add_org_team_member |
| browse_commit_diff |
| check_org_private_membership |
| check_org_public_membership |
| create_org_invitation_email |
| create_org_invitation_ghname |
| create_org_repo |
| create_tag |
| create_url_commit_diff |
| create_user_repo |
| get_collaborator_list |
| get_contributors_list |
| get_emoji_list |
| get_org_invitations |
| get_org_members_list |
| get_org_repos_list |
| get_org_team_details |
| get_org_team_invitations |
| get_org_teams_list |
| get_self_repos_list |
| get_user_repos_list |
| remove_collaborator |
| remove_org_member |
| remove_org_team_member |
| transfer_repo |
| update_org_member_role |

### License

Expand Down

0 comments on commit 265808a

Please sign in to comment.