Skip to content

Commit

Permalink
Added proper documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
warrensbox committed May 26, 2018
1 parent 4b4e4ce commit 1edb9ed
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@

<!-- ![gopher](https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/logo.png =100x20) -->

The tfswitch command lets you switch between different terraform versions.
If you do not have a particular version installed, tfswitch will download the version you desire.
The `tfswitch` command lets you switch between different terraform versions.
If you do not have a particular version installed, `tfswitch` will download the version you desire.
The installation is minimal and easy.
Simply select the version you require from the dropdown and start using terraform with ease.

See installation guide here: [tfswitch installation](https://warrensbox.github.io/terraform-switcher/)

## Installation

At the moment, installation is available for most unix/linux based operating systems.
`tfswitch` is available for MacOS and Linux based operating systems.

### Homebrew

Expand All @@ -26,8 +28,6 @@ Installation for MacOS is the easiest with Homebrew. [If you do not have homebre
brew install warrensbox/tap/tfswitch
```

To upgrade, simply run `brew upgrade warrensbox/tap/tfswitch`

### Linux

Installation for other linux operation systems.
Expand All @@ -36,8 +36,6 @@ Installation for other linux operation systems.
curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
```

To upgrade, simply run

### Install from source

Alternatively, you can install the binary from source [here](https://github.com/warrensbox/terraform-switcher/releases)
Expand All @@ -46,13 +44,13 @@ Alternatively, you can install the binary from source [here](https://github.com/

<img src="https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/tfswitch.gif" alt="drawing" style="width: 180px;"/>

1. You can start using by typing the command `tfswitch` on your terminal.
1. You can switch between different versions of terraform by typing the command `tfswitch` on your terminal.
2. Select the version of terraform you require by using the up and down arrow.
3. Hit **Enter** to select the desired version

## Additional Info

[Visit Site](https://warrensbox.github.io/terraform-switcher/)
See how to *upgrade*, *uninstall*, *troubleshoot* here:[More info](https://warrensbox.github.io/terraform-switcher/addition)


## Issues
Expand Down

0 comments on commit 1edb9ed

Please sign in to comment.