Skip to content

Commit

Permalink
rename inltc -> intlc, remove shorthand install instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
osdiab committed Sep 21, 2023
1 parent e671965 commit d21b05e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 15 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<div align="center">

# asdf-inltc [![Build](https://github.com/osdiab/asdf-inltc/actions/workflows/build.yml/badge.svg)](https://github.com/osdiab/asdf-inltc/actions/workflows/build.yml) [![Lint](https://github.com/osdiab/asdf-inltc/actions/workflows/lint.yml/badge.svg)](https://github.com/osdiab/asdf-inltc/actions/workflows/lint.yml)
# asdf-intlc [![Build](https://github.com/osdiab/asdf-intlc/actions/workflows/build.yml/badge.svg)](https://github.com/osdiab/asdf-intlc/actions/workflows/build.yml) [![Lint](https://github.com/osdiab/asdf-intlc/actions/workflows/lint.yml/badge.svg)](https://github.com/osdiab/asdf-intlc/actions/workflows/lint.yml)

[inltc](https://github.com/unsplash/intlc) plugin for the [asdf version manager](https://asdf-vm.com).
[intlc](https://github.com/unsplash/intlc) plugin for the [asdf version manager](https://asdf-vm.com).

</div>

Expand All @@ -17,24 +17,22 @@
Plugin:

```shell
asdf plugin add inltc
# or
asdf plugin add inltc https://github.com/osdiab/asdf-inltc.git
asdf plugin add intlc https://github.com/osdiab/asdf-intlc.git
```

inltc:
intlc:

```shell
# Show all installable versions
asdf list-all inltc
asdf list-all intlc

# Install specific version
asdf install inltc latest
asdf install intlc latest

# Set a version globally (on your ~/.tool-versions file)
asdf global inltc latest
asdf global intlc latest

# Now inltc commands are available
# Now intlc commands are available
intlc --version
```

Expand All @@ -45,7 +43,7 @@ install & manage versions.

Contributions of any kind welcome! See the [contributing guide](contributing.md).

[Thanks goes to these contributors](https://github.com/osdiab/asdf-inltc/graphs/contributors)!
[Thanks goes to these contributors](https://github.com/osdiab/asdf-intlc/graphs/contributors)!

# License

Expand Down
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Testing Locally:
```shell
asdf plugin test <plugin-name> <plugin-url> [--asdf-tool-version <version>] [--asdf-plugin-gitref <git-ref>] [test-command*]

asdf plugin test inltc https://github.com/osdiab/asdf-inltc.git "intlc --version"
asdf plugin test intlc https://github.com/osdiab/asdf-intlc.git "intlc --version"
```

Tests are automatically run in GitHub Actions on push and PR.
6 changes: 3 additions & 3 deletions lib/utils.bash
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
set -euo pipefail

GH_REPO="https://github.com/unsplash/intlc"
TOOL_NAME="inltc"
TOOL_NAME="intlc"
TOOL_TEST="intlc --version"

fail() {
Expand All @@ -13,7 +13,7 @@ fail() {

curl_opts=(-fsSL)

# NOTE: You might want to remove this if inltc is not hosted on GitHub releases.
# NOTE: You might want to remove this if intlc is not hosted on GitHub releases.
if [ -n "${GITHUB_API_TOKEN:-}" ]; then
curl_opts=("${curl_opts[@]}" -H "Authorization: token $GITHUB_API_TOKEN")
fi
Expand Down Expand Up @@ -57,7 +57,7 @@ install_version() {
cp -r "$ASDF_DOWNLOAD_PATH"/* "$install_path/intlc"
chmod +x "$install_path/intlc"

# TODO: Assert inltc executable exists.
# TODO: Assert intlc executable exists.
local tool_cmd
tool_cmd="$(echo "$TOOL_TEST" | cut -d' ' -f1)"
test -x "$install_path/$tool_cmd" || fail "Expected $install_path/$tool_cmd to be executable."
Expand Down

0 comments on commit d21b05e

Please sign in to comment.