Skip to content

Commit a149d4e

Browse files
authored
Merge pull request #2096 from svenstaro/patch-1
Be more explicit about how gitoxide should be used
2 parents 589d63e + 8123fe8 commit a149d4e

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@
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.
8+
There are two primary ways to use `gitoxide`:
109

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.
10+
1. **As Rust library**: Use the [`gix`](https://docs.rs/gix) crate as a Cargo dependency for API access.
11+
1. **As command-line tool**: The `gix` binary as development tool to help testing the API in real repositories,
12+
and the `ein` binary with workflow-enhancing tools. Both binaries may forever be unstable,
13+
*do not rely on them in scripts*.
1214

1315
[![asciicast](https://asciinema.org/a/542159.svg)](https://asciinema.org/a/542159)
1416

0 commit comments

Comments
 (0)