diff --git a/README.md b/README.md index 005a23491..4c961a584 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,14 @@ The central object in the `git2r` package is the S4 class `git_repository`. The following three methods can instantiate a repository; `init`, `repository` and `clone`. +#### Open an existing repository + +Use `repository` if you are already working in a git repository. + +``` +repo <- repository() +``` + #### Create a new repository Create a new repository in a temporary directory using `init`