diff options
author | Richard Burke <rich.g.burke@gmail.com> | 2018-01-29 22:40:05 +0000 |
---|---|---|
committer | Richard Burke <rich.g.burke@gmail.com> | 2018-01-29 22:40:05 +0000 |
commit | d770fba85c8821d5fe80d544d658a5bf71b2072d (patch) | |
tree | 9d522f87dbc9810e83d4f8b9c93a977e745c2365 | |
parent | 1887d6266c8e4b5cf0a937c58f758c57f7ac9f16 (diff) |
Updated READMEv0.1.0
-rw-r--r-- | README.md | 12 | ||||
-rw-r--r-- | doc/documentation.md | 2 | ||||
-rw-r--r-- | doc/grv-classic-theme.png | bin | 0 -> 485976 bytes | |||
-rw-r--r-- | doc/grv-commit-views.png | bin | 0 -> 581828 bytes | |||
-rw-r--r-- | doc/grv-custom-view.png | bin | 0 -> 340808 bytes | |||
-rw-r--r-- | doc/grv-history-view.png | bin | 0 -> 470612 bytes | |||
-rw-r--r-- | doc/grv-status-view.png | bin | 0 -> 231266 bytes | |||
-rw-r--r-- | doc/screenshots.md | 18 |
8 files changed, 29 insertions, 3 deletions
@@ -6,11 +6,17 @@ and style can be customised through configuration. A query language can be used to filter refs and commits, see the [Documentation](#documentation) section for more information. -GRV is currently under development and not feature complete. +![Screenshot](./doc/grv-history-view.png) -## Demo +More screenshots can be seen [here](doc/screenshots.md) -![Demo](doc/grv.gif) +## Features + + - Commits and refs can be filtered using a query language. + - Changes to the repository are captured by monitoring the filesystem allowing the UI to be updated automatically. + - Organised as tabs and splits. Custom tabs and splits can be created using any combination of views. + - Vi like keybindings by default, key bindings can be customised. + - Custom themes can be created. ## Documentation diff --git a/doc/documentation.md b/doc/documentation.md index 329b388..b19c924 100644 --- a/doc/documentation.md +++ b/doc/documentation.md @@ -51,6 +51,8 @@ GRV accepts the following command line arguments: Logging level [NONE|PANIC|FATAL|ERROR|WARN|INFO|DEBUG] (default "NONE") -repoFilePath string Repository file path (default ".") +-version + Print version ``` ## Key Bindings diff --git a/doc/grv-classic-theme.png b/doc/grv-classic-theme.png Binary files differnew file mode 100644 index 0000000..c6630c2 --- /dev/null +++ b/doc/grv-classic-theme.png diff --git a/doc/grv-commit-views.png b/doc/grv-commit-views.png Binary files differnew file mode 100644 index 0000000..849dff4 --- /dev/null +++ b/doc/grv-commit-views.png diff --git a/doc/grv-custom-view.png b/doc/grv-custom-view.png Binary files differnew file mode 100644 index 0000000..fa54719 --- /dev/null +++ b/doc/grv-custom-view.png diff --git a/doc/grv-history-view.png b/doc/grv-history-view.png Binary files differnew file mode 100644 index 0000000..99c1a91 --- /dev/null +++ b/doc/grv-history-view.png diff --git a/doc/grv-status-view.png b/doc/grv-status-view.png Binary files differnew file mode 100644 index 0000000..da6bdc8 --- /dev/null +++ b/doc/grv-status-view.png diff --git a/doc/screenshots.md b/doc/screenshots.md new file mode 100644 index 0000000..5fff9e7 --- /dev/null +++ b/doc/screenshots.md @@ -0,0 +1,18 @@ +# Screenshots + +### Status View +![Screenshot](./grv-status-view.png) + +### Vertical Split +![Screenshot](./grv-commit-views.png) + +### Custom tab comprised of all views currently available in GRV +![Screenshot](./grv-custom-view.png) + +### Classic Theme +![Screenshot](./grv-classic-theme.png) + +### Old Demo + +![Demo](./grv.gif) + |