Skip to content

Commit

Permalink
docs: add instalation, use and commands section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dplocki committed Jun 21, 2024
1 parent ff81d7b commit 972b93a
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,38 @@

The [BASH](https://www.gnu.org/software/bash/manual/bash.html#What-is-Bash_003f) project allows for more interactivity with certain console tools, like [Git](https://git-scm.com/) and [NVM](https://github.com/nvm-sh/nvm).
The project also provides a toolset for easy extension.

## Installation

Put the package content in some of the `PATH` location.

The file `git_switch_branch.sh` has to be put inside the directory. But all other files (those without extensions) can be skipped. If you are not interested with particular command just do not install it.

## Use

After installation, you can use additional commands (unless omitted during [the installation process](#installation)).

## Commands

| Command | Source command | The result command |
|:----------------------|:---------------|:-------------------------|
| `git_switch_branch` |`git branch` |`git checkout $selection` |
| `nvm_select` |`nvm list` |`nvm use $selection` |

### How to find the correct place

You can see the directories listed in the PATH:

```sh
echo $PATH
```

On Linux it maybe be usually `~/.local/bin`.

On Windows system you can also use the command:

```bat
echo %PATH%
```

but it will be better to open "Environment Variables" and then select "User".

0 comments on commit 972b93a

Please sign in to comment.