Elgato_dark/gitui
1
0
Fork 0
mirror of https://github.com/gitui-org/gitui synced 2026-05-24 09:28:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

better readme structure

Browse source
This commit is contained in:
Stephan Dilly 2020-03-23 15:16:54 +01:00
parent 46f582df08
commit 67c119457f
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -10,6 +10,14 @@ blazing fast terminal-ui for git written in rust
![img](assets/main.jpg) ![img](assets/main.jpg)
![img](assets/demo.gif) ![img](assets/demo.gif)
## features
* inspect changes
* (un)stage files
* commit
* async [input polling](assets/perf_compare.jpg) and
* async git API for fluid control
## motivation ## motivation
I do most of my git usage in a terminal but I frequently found myself using git UIs for some use cases like: index/commit, diff, stash and log. I do most of my git usage in a terminal but I frequently found myself using git UIs for some use cases like: index/commit, diff, stash and log.
@ -38,15 +46,12 @@ after that you can go to your git repo and run it:
gitui gitui
``` ```
# todo # todo for 0.1 (first release)
* [x] (un)stage files
* [x] inspect diffs
* [x] commit
* [x] [input polling in thread](assets/perf_compare.jpg)
* [x] async git API for fluid control
* [ ] discard untracked files (remove) * [ ] discard untracked files (remove)
* [ ] (un)staging selected hunks * [ ] (un)staging selected hunks
* [ ] publish as homebrew-tap
* [ ] release on crates.io
# alternatives # alternatives