Skip to content

Commit d770fba

Browse files
committed
Updated README
1 parent 1887d62 commit d770fba

8 files changed

+29
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,17 @@ and style can be customised through configuration. A query language can
66
be used to filter refs and commits, see the [Documentation](#documentation)
77
section for more information.
88

9-
GRV is currently under development and not feature complete.
9+
![Screenshot](./doc/grv-history-view.png)
1010

11-
## Demo
11+
More screenshots can be seen [here](doc/screenshots.md)
1212

13-
![Demo](doc/grv.gif)
13+
## Features
14+
15+
- Commits and refs can be filtered using a query language.
16+
- Changes to the repository are captured by monitoring the filesystem allowing the UI to be updated automatically.
17+
- Organised as tabs and splits. Custom tabs and splits can be created using any combination of views.
18+
- Vi like keybindings by default, key bindings can be customised.
19+
- Custom themes can be created.
1420

1521
## Documentation
1622

doc/documentation.md

+2
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ GRV accepts the following command line arguments:
5151
Logging level [NONE|PANIC|FATAL|ERROR|WARN|INFO|DEBUG] (default "NONE")
5252
-repoFilePath string
5353
Repository file path (default ".")
54+
-version
55+
Print version
5456
```
5557

5658
## Key Bindings

doc/grv-classic-theme.png

475 KB
Loading

doc/grv-commit-views.png

568 KB
Loading

doc/grv-custom-view.png

333 KB
Loading

doc/grv-history-view.png

460 KB
Loading

doc/grv-status-view.png

226 KB
Loading

doc/screenshots.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Screenshots
2+
3+
### Status View
4+
![Screenshot](./grv-status-view.png)
5+
6+
### Vertical Split
7+
![Screenshot](./grv-commit-views.png)
8+
9+
### Custom tab comprised of all views currently available in GRV
10+
![Screenshot](./grv-custom-view.png)
11+
12+
### Classic Theme
13+
![Screenshot](./grv-classic-theme.png)
14+
15+
### Old Demo
16+
17+
![Demo](./grv.gif)
18+

0 commit comments

Comments
 (0)