diff --git a/README.md b/README.md index e23f4dc4490..c4c491a28bd 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,12 @@ `gitoxide` is an implementation of `git` written in Rust for developing future-proof applications which strive for correctness and performance while providing a pleasant and unsurprising developer experience. -`gitoxide` provides the `gix` and `ein` binaries for use on the command-line to allow experimentation with key features -like `fetch` and `clone`, and to validate the usability and control of the API offered by the [`gix`] crate. +There are two primary ways to use `gitoxide`: -`gitoxide` aspires to be a production-grade server implementation and the `ein` binary aspires to become the default way to interact with git repositories. +1. **As Rust library**: Use the [`gix`](https://docs.rs/gix) crate as a Cargo dependency for API access. +1. **As command-line tool**: The `gix` binary as development tool to help testing the API in real repositories, + and the `ein` binary with workflow-enhancing tools. Both binaries may forever be unstable, + *do not rely on them in scripts*. [![asciicast](https://asciinema.org/a/542159.svg)](https://asciinema.org/a/542159)