Skip to content

Commit 4b056dd

Browse files
Update README.md
Describe the changes in installation and update caused by changing the technical name of the plugin from `JavaPlugin` to `java`.
1 parent f0ca5bd commit 4b056dd

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,24 @@ Make sure you have the CF Community plugin repository configured or add it via (
1414

1515
Trigger installation of the plugin via
1616
```
17-
cf install-plugin -r CF-Community "java-plugin"
17+
cf install-plugin -r CF-Community "java"
1818
```
1919

2020
### Manual Installation
2121
Download the binary file for your target OS from the [latest release](https://github.com/SAP/cf-cli-java-plugin/releases/latest).
2222

23-
If you've already installed the plugin and are updating it, you must first execute the `cf uninstall-plugin JavaPlugin` command.
23+
If you've already installed the plugin and are updating it, you must first execute the `cf uninstall-plugin java` command.
2424

2525
Install the plugin with `cf install-plugin [cf-cli-java-plugin]` (replace `[cf-cli-java-plugin]` with the actual binary name you will use, which depends on the OS you are running).
2626

27-
You can verify that the plugin is successfully installed by looking for `JavaPlugin` in the output of `cf plugins`.
27+
You can verify that the plugin is successfully installed by looking for `java` in the output of `cf plugins`.
28+
29+
### Updating from version 1.x to 2.x
30+
31+
With release 2.0 we aligned the convention of the plugin having the same name as the command it contributes (in our case, `java`).
32+
This change mostly affects you in the way you update your plugin.
33+
If you have the version 1.x installed, you will need to uninstall the old version first by using the command: `cf uninstall-plugin JavaPlugin`.
34+
You know you have the version 1.x installed if `JavaPlugin` appears in the output of `cf plugins`.
2835

2936
### Permission Issues
3037

0 commit comments

Comments
 (0)