Skip to content

Commit

Permalink
Update README and Cargo.toml to include OpenTofu
Browse files Browse the repository at this point in the history
  • Loading branch information
ASleepyCat committed Oct 5, 2023
1 parent bc9b75e commit 21bc1a5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 14 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ version = "0.3.0"
edition = "2021"
authors = ["ASleepyCat [email protected]"]
license = "MIT"
description = "A Terraform version switcher"
description = "A Terraform and OpenTofu version switcher"
readme = "README.md"
repository = "https://github.com/ASleepyCat/tfswitcher"
keywords = ["cli", "terraform", "tfswitcher", "tfswitch"]
keywords = ["cli", "terraform", "opentofu", "tofu", "tfswitcher", "tfswitch"]
categories = ["command-line-utilities"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# tfswitcher

[`tfswitch`](https://github.com/warrensbox/terraform-switcher/)-like program but written in Rust.
Terraform and OpenTofu version switcher written in Rust.

## Installation

Expand Down Expand Up @@ -35,19 +35,8 @@ Alternatively, you can source the tab-completion script inside your shell's star
echo "source <(tfswitcher -c bash)" >> ~/.bashrc
```

## Motivations

* Improved performance on WSL (if `$PATH` contains Windows directories)
* Better code quality
* This is somewhat subjective, but I found debugging on `tfswitch` to be pretty cumbersome with all the `os.Exit()`s there are
* I wanted to try out Rust

## Caveats

This is not a complete reimplementation of `tfswitch`, as there are some missing flags that haven't been implemented. If you rely on these missing flags, raise an issue and I'll add it in.

This is also my first non-trivial public Rust project; if there is a mistake I've made that doesn't conform to standard Rust coding practices, please raise an issue about it.

This has not been tested on Windows or macOS, so YMMV.

## Where's `v0.1.0`?
Expand Down

0 comments on commit 21bc1a5

Please sign in to comment.