Skip to content

Commit 8123fe8

Browse files
committed
Tune README.md
1 parent 14c12ef commit 8123fe8

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +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-
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.
8+
There are two primary ways to use `gitoxide`:
9+
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*.
1614

1715
[![asciicast](https://asciinema.org/a/542159.svg)](https://asciinema.org/a/542159)
1816

0 commit comments

Comments
 (0)