Skip to content

Commit 14c12ef

Browse files
authored
Be more explicit about how gitoxide should be used
This is as per #2089 where suggested to mention the library more prominently.
1 parent 8f51845 commit 14c12ef

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@
55
`gitoxide` is an implementation of `git` written in Rust for developing future-proof applications which strive for correctness and
66
performance while providing a pleasant and unsurprising developer experience.
77

8-
`gitoxide` provides the `gix` and `ein` binaries for use on the command-line to allow experimentation with key features
9-
like `fetch` and `clone`, and to validate the usability and control of the API offered by the [`gix`] crate.
10-
11-
`gitoxide` aspires to be a production-grade server implementation and the `ein` binary aspires to become the default way to interact with git repositories.
8+
There are two primary ways to use gitoxide:
9+
10+
1. **CLI binaries**: The provided binaries `gix` and `ein` for use on the command-line allow experimentation with key features
11+
like fetch and clone, and to validate the usability.
12+
`gitoxide` aspires to be a production-grade server implementation and the `ein` binary aspires to become the default way to interact
13+
with git repositories.
14+
3. **Rust library**: Use the [gix](https://docs.rs/gix) crate in your project to access the features offered by gitoxide
15+
programmatically.
1216

1317
[![asciicast](https://asciinema.org/a/542159.svg)](https://asciinema.org/a/542159)
1418

0 commit comments

Comments
 (0)