From 6859b930ddfedc8439d8cfa404738e40f7e74892 Mon Sep 17 00:00:00 2001 From: sgoudham Date: Thu, 9 Jun 2022 03:04:25 +0100 Subject: [PATCH] docs: WIP Update README.md --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d0bf43..a73fd0d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,56 @@ -# git-browser +# git-view -A git sub-command to open your git repository in the web browser... written in Rust :D +[![build](https://github.com/sgoudham/git-view/actions/workflows/build.yml/badge.svg)](https://github.com/sgoudham/git-view/actions/workflows/build.yml) +[![crate.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) +[![license](https://img.shields.io/github/license/sgoudham/git-view)](LICENSE) + +> A git sub-command to open your git repository in the web browser! + +## Table Of Contents + +TODO + +## About + +Are you frustrated from moving your hands away from the keyboard to open your git repository in the browser? + +> Me too! + +`git-view` allows you to do _just that._ +_Note: The use of a mouse or trackpad may be required to navigate the browser :P_ + +## Features + +TODO + +## Installation + +TODO + +## Usage + +```commandline +$ git view -h + +... + +USAGE: + git-view.exe [OPTIONS] + +OPTIONS: + -r, --remote The remote to view git repository on + -b, --branch The branch to view git repository on + -c, --commit The commit to view git repository on + -p, --print Print the URL (doesn't open browser) + -h, --help Print help information + -V, --version Print version information +``` + +## License + +[MIT License](LICENSE) + +## Acknowledgement + +The idea for this project came about from the existing [git-open](https://github.com/paulirish/git-open/blob/master/git-open) github repository