From df2d5572d993d11fb00fccb9ce3e56d5043082ec Mon Sep 17 00:00:00 2001 From: sgoudham Date: Sun, 2 Jul 2023 12:46:46 +0100 Subject: [PATCH] docs(README): new shield.io badges --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6f0b4fb..dcaa3c6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ -# git-view +

+ git-view ( + ) +

-[![build](https://github.com/sgoudham/git-view/actions/workflows/build.yml/badge.svg)](https://github.com/sgoudham/git-view/actions/workflows/build.yml) -[![crates.io](https://img.shields.io/crates/v/git-view)](https://crates.io/crates/git-view) -[![downloads](https://img.shields.io/crates/d/git-view)](https://crates.io/crates/git-view) - -> A git sub-command to view your git repository on GitHub! +

+ + + +

## About @@ -12,7 +15,7 @@ Are you _**also**_ frustrated from moving your hands away from the keyboard to v > Me too!!! -`git-view` alleviates that pain by allowing you to chuck away your mouse! +`git-view` alleviates that pain by allowing you to chuck away your mouse and instead open it via the CLI! > **Note:**
> You should always use `git view -h` instead of `git view --help` as the manpage/html files are **NOT** included. @@ -53,7 +56,7 @@ $ git view --remote remote --branch branch # https://github.com/PROVIDED_REMOTE_USER/REPO/tree/PROVIDED_BRANCH $ git view --issue -# Given branch 'TICKET-123' or some other variation +# Branch 'TICKET-123' # https://github.com/TRACKED_REMOTE_USER/REPO/issues/123 $ git view --issue 42 @@ -66,11 +69,11 @@ $ git view --commit efa38be50ad34d # https://github.com/TRACKED_REMOTE_USER/REPO/tree/efa38be50ad34d $ git view --commit efa38be50ad34d --path src/lib.rs -# https://github.com/TRACKED_REMOTE_USER/REPO/tree/efa38be50ad34d/src/main.rs +# https://github.com/TRACKED_REMOTE_USER/REPO/tree/efa38be50ad34d/src/lib.rs $ git view --path -# Given working directory 'src/lib.rs' -# https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH/src/main.rs +# Working Directory 'src/lib.rs' +# https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH/src/lib.rs $ git view --path CONTRIBUTING.md # https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH/CONTRIBUTING.md