Skip to content

Commit 7296af5

Browse files
committed
inform about feature discovery
1 parent f603fd7 commit 7296af5

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,36 @@ For use in applications, look for the [`gix`](https://github.com/Byron/gitoxide/
2323
which serves as entrypoint to the functionality provided by various lower-level plumbing crates like
2424
[`gix-config`](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-config).
2525

26+
### Feature Discovery
27+
28+
> Can `gix` do what I need it to do?
29+
30+
The above can be hard to answer and this paragraph is here to help with feature discovery.
31+
32+
Look at [`crate-status.md`](https://github.com/Byron/gitoxide/blob/main/crate-status.md) for a rather exhaustive document that contains
33+
both implemented and planned features.
34+
35+
Further, the [`gix` crate documentation with the `git2` search term](https://docs.rs/gix/0.54.1/gix/?search=git2) helps to find all currently
36+
known `git2` equivalent method calls. Please note that this list is definitely not exhaustive yet, but might help if you are coming from `git2`.
37+
38+
What follows is a high-level list of features along with their support
39+
40+
* [x] clone
41+
* [x] fetch
42+
* [ ] push
43+
* [ ] reset
44+
* [ ] status
45+
* [ ] merge
46+
* [ ] rebase
47+
* [ ] commit
48+
* [x] reading and writing of objects
49+
* [x] reading and writing of refs
50+
* [x] reading and writing of `.git/index`
51+
* [x] reading and writing of git configuration
52+
* [x] pathspecs
53+
* [x] revspecs
54+
* [x] `.gitignore` and `.gitattributes`
55+
2656
### Crates
2757

2858
Follow linked crate name for detailed status. Please note that all crates follow [semver] as well as the [stability guide].

0 commit comments

Comments
 (0)