diff --git a/README.md b/README.md index b22fc6d9..18270898 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,61 @@ [![Build Status](https://travis-ci.org/warrensbox/terraform-switcher.svg?branch=master)](https://travis-ci.org/warrensbox/terraform-switcher) [![Go Report Card](https://goreportcard.com/badge/github.com/warrensbox/terraform-switcher)](https://goreportcard.com/report/github.com/warrensbox/terraform-switcher) [![CircleCI](https://circleci.com/gh/warrensbox/terraform-switcher/tree/master.svg?style=shield&circle-token=55ddceec95ff67eb38269152282f8a7d761c79a5)](https://circleci.com/gh/warrensbox/terraform-switcher) -# terraform-switcher -#remove this +# Terraform Switcher + + + + + +The `tfswitch` command line tool lets you switch between different versions of [terraform](https://www.terraform.io/). +If you do not have a particular version of terraform installed, `tfswitch` will download the version you desire. +The installation is minimal and easy. +Once installed, simply select the version you require from the dropdown and start using terraform. + +See installation guide here: [tfswitch installation](https://warrensbox.github.io/terraform-switcher/) + +## Installation + +`tfswitch` is available for MacOS and Linux based operating systems. + +### Homebrew + +Installation for MacOS is the easiest with Homebrew. [If you do not have homebrew installed, click here](https://brew.sh/). + + +```ruby +brew install warrensbox/tap/tfswitch +``` + +### Linux + +Installation for other linux operation systems. + +```sh +curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash +``` + +### Install from source + +Alternatively, you can install the binary from source [here](https://github.com/warrensbox/terraform-switcher/releases) + +## How to use: + + + +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 + +See how to *upgrade*, *uninstall*, *troubleshoot* here:[More info](https://warrensbox.github.io/terraform-switcher/additional) + + +## Issues + +Please open *issues* here: [New Issue](https://github.com/warrensbox/terraform-switcher/issues) diff --git a/docs/_config.yml b/docs/_config.yml index 62674304..05e2b0a9 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,8 +1,9 @@ theme: jekyll-theme-minimal -github: [metadata] +#github: [metadata] repository: warrensbox/terraform-switcher logo: /assets/img/logo.png +title: tfswitch show_downloads: true -github: [metadata] +#github: [metadata] diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index ded16043..10a114c6 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -4,6 +4,7 @@ + {% seo %} @@ -14,46 +15,38 @@
+ +
-{{ site.description | default: site.github.project_tagline }}
+{{ site.description | default: site.github.project_tagline }}
VERSION: {{ site.github.releases[0].tag_name }}. This project is maintained by {{ site.github.owner_name }}
+ {% endif %}+ +
+ +The tfswitch command line tool lets you switch between different versions of terraform
+ + + + +brew upgrade warrensbox/tap/tfswitch
+
Rerun:
+ +curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
+
brew uninstall warrensbox/tap/tfswitch
+
Rerun:
+ +rm /usr/local/bin/tfswitch
+
Common issues:
+install: can't change permissions of /usr/local/bin: Operation not permitted
+
"Unable to remove symlink. You must have SUDO privileges"
+
"Unable to create symlink. You must have SUDO privileges"
+
You probably need to have sudo privileges to install tfswitch.
+ + + + +VERSION: 0.3.256. This project is maintained by warrensbox
+ ++ +
-The tfswitch command lets you switch between terraform versions
+The tfswitch command line tool lets you switch between different versions of terraform
Often times, we work with different versions -of terraform for multiple projects. The tfswitch -command lets you switch different versions of the terraform installation on your computer. The installation is minimal and -easy. Simply select the version you require from the dropdown and -start using terraform with ease.
- -You can find the source code for Minima at GitHub: -jekyll / -minima
- -You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
- -This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
- -You can find the source code for Minima at GitHub: -jekyll / -minima
- -You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
+The tfswitch
command line tool lets you switch between different versions of terraform.
+If you do not have a particular version of terraform installed, tfswitch
will download the version you desire.
+The installation is minimal and easy.
+Once installed, simply select the version you require from the dropdown and start using terraform.
This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
+You can find the source code for Minima at GitHub: -jekyll / -minima
+tfswitch
is available for MacOS and Linux based operating systems.
You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
+Installation for MacOS is the easiest with Homebrew. If you do not have homebrew installed, click here.
-This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
+brew install warrensbox/tap/tfswitch
+
You can find the source code for Minima at GitHub: -jekyll / -minima
+You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
+Installation for Linux operation systems.
-curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
+
This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
+You can find the source code for Minima at GitHub: -jekyll / -minima
+Alternatively, you can install the binary from the source here
-You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
+This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
+ -You can find the source code for Minima at GitHub: -jekyll / -minima
+tfswitch
on your terminal.You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
+This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
- -You can find the source code for Minima at GitHub: -jekyll / -minima
- -You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
- -This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
- -You can find the source code for Minima at GitHub: -jekyll / -minima
- -You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
- -This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com
- -You can find the source code for Minima at GitHub: -jekyll / -minima
- -You can find the source code for Jekyll at GitHub: -jekyll / -jekyll
+Please open issues here: New Issue
+See how to upgrade, uninstall, troubleshoot here: +Additional Info
+ +VERSION: 0.3.256. This project is maintained by warrensbox
+