Skip to content

Commit 535b0cd

Browse files
author
Stephan Dilly
committed
little more documentation
1 parent 083e06c commit 535b0cd

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

asyncgit/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# asyncgit
22

3-
*allow using git2 in a asynchronous context*
3+
*allow using git2 in an asynchronous context*
4+
5+
This crate is designed as part of the [gitui](http://gitui.org) project.
6+
7+
`asyncgit` provides the primary interface to interact with *git* repositories. It is split into the main module and a `sync` part. The latter provides convenience wrapper for typical usage patterns against git repositories.
8+
9+
The primary goal however is to allow putting certain (potentially) long running [git2](https://github.com/rust-lang/git2-rs) calls onto a thread pool.[crossbeam-channel](https://github.com/crossbeam-rs/crossbeam) is then used to wait for a notification confirming the result.
10+
11+
In `gitui` this allows the main-thread and therefore the *ui* to stay responsive.
412

5-
This crate is part of the [gitui](http://gitui.org) project.
6-
It is used put long running [git2](https://github.com/rust-lang/git2-rs) calls onto a thread pool and use [crossbeam-channel](https://github.com/crossbeam-rs/crossbeam) to wait for a message to confirm the call finished.

0 commit comments

Comments
 (0)