Skip to content

Commit dfd9b91

Browse files
committed
README.md: Add feature documentation
1 parent 05fa593 commit dfd9b91

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,20 @@
44

55
libgit2 bindings for Rust.
66

7-
```toml
8-
[dependencies]
9-
git2 = "0.21"
7+
```
8+
cargo add git2
9+
```
10+
11+
## Features
12+
13+
By default, git2 includes support for working with local repositories, but does
14+
not include network support (e.g. cloning remote repositories). If you want to
15+
use features that require network support, you may need the `"https"` and/or
16+
`"ssh"` features. If you support user-provided repository URLs, you probably
17+
want to enable both.
18+
19+
```
20+
cargo add git2 --features https,ssh
1021
```
1122

1223
## Rust version requirements

0 commit comments

Comments
 (0)