Skip to content

Commit d85d236

Browse files
authored
fix very outdated readme that mentions S4 and head() (#418)
1 parent 0b30ed1 commit d85d236

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ $ make install
4444

4545
### Repository
4646

47-
The central object in the `git2r` package is the S4 class
47+
The central object in the `git2r` package is the S3 class
4848
`git_repository`. The following three methods can instantiate a
4949
repository; `init`, `repository` and `clone`.
5050

@@ -220,7 +220,7 @@ commits(repo)[[1]] # Truncated here for readability
220220
```coffee
221221

222222
## Get HEAD of repository
223-
head(repo)
223+
repository_head(repo)
224224
```
225225

226226
```
@@ -230,7 +230,7 @@ head(repo)
230230
```coffee
231231

232232
## Check if HEAD is head
233-
is_head(head(repo))
233+
is_head(repository_head(repo))
234234
```
235235

236236
```
@@ -240,7 +240,7 @@ is_head(head(repo))
240240
```coffee
241241

242242
## Check if HEAD is local
243-
is_local(head(repo))
243+
is_local(repository_head(repo))
244244
```
245245

246246
```

0 commit comments

Comments
 (0)