Skip to content

Commit e246be5

Browse files
committed
docs: Define crates purpose
1 parent ba890da commit e246be5

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
![License](https://img.shields.io/crates/l/git2-ext.svg)
77
[![Crates Status](https://img.shields.io/crates/v/git2-ext.svg)](https://crates.io/crates/git2-ext)
88

9+
## About
10+
11+
Goals:
12+
- Provide "good enough" implementations of essential or higher-level git2 logic, like cherry-pick, squash, hooks, authentication (not implemented yet), etc
13+
- The above serves as examples for people needing to write their own implementations
14+
915
## License
1016

1117
Licensed under either of

src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
//! Extensions for git2
2+
//!
3+
//! Goals:
4+
//! - Provide "good enough" implementations of essential or higher-level git2 logic, like cherry-pick, squash, hooks, authentication (not implemented yet), etc
5+
//! - The above serves as examples for people needing to write their own implementations
6+
17
pub mod hooks;
28
pub mod ops;
39
pub mod utils;

0 commit comments

Comments
 (0)