> A git sub-command to view your git repository in the web browser!
## Table Of Contents
TODO
## About
Are you _also_ frustrated from moving your hands away from the keyboard to view your git repository in the browser?
@ -21,32 +17,165 @@ Are you _also_ frustrated from moving your hands away from the keyboard to view
> (n)vim users rejoice :P
**_Important Note: You should always use `git view -h` instead of `git view --help` as the manpage/html files are NOT included._**
## Features
- [x] GitHub & BitBucket
- [x] View Branches, Commits & Issues
- [x] Custom Suffix
- [x] Custom Remote
- [ ] View Profile
- [ ] View Current Directory
Feel free to raise any issues or pull requests (after having read the [CONTRIBUTING.md]()!!) for any additional Features
Feel free to raise any issues or pull requests (after having read the [CONTRIBUTING.md](./CONTRIBUTING.md)!) for any additional features
that you want!
## Usage
## Installation
The _preferred_ way of installation is to manually install the provided binaries into your local `git` directory to enable
the usage as `git view`. However, that being said, it also available on [crates.io]() to allow installation through the use of `cargo`.
### Cargo
### Windows
The _preferred_ way of installation is to manually install the provided binaries and update your `$PATH` variable to enable
the usage as `git view` globally. However, that being said, it also available on [crates.io](https://crates.io/crates/git-view) to allow installation
through the use of Rust's build tool and package manager `cargo`.
### *nix / macOS
> If you do not have `cargo` available on your machine, you can download it [here](https://www.rust-lang.org/tools/install)
## Usage
```shell
$ cargo install git-view
```
Refresh terminal & verify installation
```shell
$ git view --version
git-view 0.1.0
```
### Homebrew
For `macOS` users, installation through [Homebrew](https://brew.sh/) is recommended.
```shell
$ brew tap sgoudham/tap
$ brew install git-view
```
Refresh terminal & verify installation
```shell
$ git view --version
git-view 0.1.0
```
### Binaries
Pre-compiled binaries are _always_ available with every single [release](https://github.com/sgoudham/git-view/releases) for **Windows**, **macOS** and **Linux**.
The examples shown below will showcase the installation of the binaries living within the local `git` directory but realistically, any path will
work if updated correctly within `$PATH`.
#### Windows
1. Download either `git-view-x86_64-pc-windows-msvc.zip` or `git-view-x86_64-pc-windows-gnu.zip`
2. Find local `git` directory
```shell
# CMD
$ where git
C:\Program Files\Git\cmd\git.exe
# PowerShell
$ (Get-Command git.exe).Path
C:\Program Files\Git\cmd\git.exe
```
3. `cd` into above path & extract downloaded binary zip
```shell
$ cd 'C:\Program Files\Git\cmd'
```commandline
$ git view --help
$ tar -xf git-view-x86_64-pc-windows-msvc.zip
# OR
$ tar -xf git-view-x86_64-pc-windows-gnu.zip
```
4. Ensure `%PATH%` is updated
```shell
# Only required if git-view exists within a path not already included within %PATH%
$ setx path "%path%;C:\your\path\here\bin"
```
5. Refresh terminal and verify installation
```shell
$ git view --version
git-view 0.1.0
```
#### Linux / macOS
1. Download `git-view-x86_64-unknown-linux-gnu.tar.gz` or `git-view-x86_64-unknown-linux-musl.tar.gz`
or `git-view-x86_64-apple-darwin.tar.gz`
2. Extract into your local directory
```shell
# Linux
$ tar -xf git-view-x86_64-unknown-linux-gnu.tar.gz
$ tar -xf git-view-x86_64-unknown-linux-musl.tar.gz
# macOS
$ tar -xf git-view-x86_64-apple-darwin.tar.gz
```
3. Move into `~/bin`
```shell
# Create ~/bin if it does not exist
$ mkdir -p ~/bin
$ mv git-view ~/bin
```
4. Set permissions for executable
```shell
$ chmod 755 ~/bin/git-view
```
5. Ensure `$PATH` is updated
```shell
# Only required if git-view exists within a path not already included within $PATH
