Skip to content

Commit

Permalink
doc(README.md): Remove the version placeholder with actual latest one
Browse files Browse the repository at this point in the history
I plan to bump this version in the README and in examples/install.yaml
in every upcoming release
  • Loading branch information
tampakrap committed Mar 31, 2024
1 parent ccf5b00 commit efaef98
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,28 +67,21 @@ sed -e "s/YOUR_API_KEY/$SPOTIFY_API_KEY/" examples/providerconfig/secret.yaml.tm

Install the provider by using the following command after changing the image tag
to the [latest release](https://marketplace.upbound.io/providers/tampakrap/provider-spotify)
using either of the following methods (replace `$LATEST_VERSION` accordingly):
using either of the following methods:

- Using [up](https://docs.upbound.io/reference/cli/):
```bash
up ctp provider install tampakrap/provider-spotify:v$LATEST_VERSION
up ctp provider install tampakrap/provider-spotify:v0.1.0
```

- Using [crossplane](https://docs.crossplane.io/latest/cli/):
```bash
crossplane xpkg install provider tampakrap/provider-spotify:v$LATEST_VERSION
crossplane xpkg install provider tampakrap/provider-spotify:v0.1.0
```

- Using declarative installation:
```bash
cat <<EOF | kubectl apply -f -
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
name: provider-spotify
spec:
package: tampakrap/provider-spotify:v$LATEST_VERSION
EOF
kubectl apply -f examples/install.yaml
```

You can see the API reference [here](https://doc.crds.dev/github.com/tampakrap/provider-spotify).
Expand All @@ -102,8 +95,8 @@ kubectl apply -f examples/providerconfig/
You should get outputs similar to the following:
```
➜ kubeclt get providers
NAME INSTALLED HEALTHY PACKAGE AGE
provider-spotify True True tampakrap/provider-spotify:v$LATEST_VERSION 12m
NAME INSTALLED HEALTHY PACKAGE AGE
provider-spotify True True tampakrap/provider-spotify:v0.1.0 12m
➜ kubectl get spotify
NAME AGE
providerconfig.spotify.crossplane.io/default 4m9s
Expand Down

0 comments on commit efaef98

Please sign in to comment.