README.adoc in kpm-0.9.0 vs README.adoc in kpm-0.10.0
- old
+ new
@@ -12,22 +12,28 @@
[[kpm-installation]]
== KPM Installation
[[pre-built-binaries-recommended]]
=== Pre-built binaries (recommended)
+image:https://img.shields.io/maven-central/v/org.kill-bill.billing.installer/kpm?color=blue&label=kpm[kpm]
-KPM self-contained builds are available on http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.installer%22%20AND%20a%3A%22kpm%22[Maven Central] with coordinates `org.kill-bill.billing.installer:kpm`.
+On Linux and MacOS, you can use the pre-built binaries. KPM self-contained builds are available on http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.installer%22%20AND%20a%3A%22kpm%22[Maven Central] with coordinates `org.kill-bill.billing.installer:kpm`.
Download the `.tar.gz` package matching your architecture (Linux and MacOS only).
Note that this installation method assumes `/bin/bash` to be available on your system.
[[through-rubygems]]
=== Through Rubygems
+image:https://img.shields.io/gem/v/kpm?color=blue&label=kpm[kpm]
-KPM is also available on https://rubygems.org/gems/kpm[RubyGems.org].
+On Windows, you can install KPM via https://rubygems.org/gems/kpm[RubyGems.org]. For this, you need to first install Ruby. Ruby can be installed via https://rubyinstaller.org/[RubyInstaller]. Once installed, you can run the following command to install KPM:
+[source,bash]
+gem install kpm
+
+
[[kpm-commands]]
== KPM Commands
[[kill-bill-installation]]
=== Kill Bill installation
@@ -247,16 +253,30 @@
* When `--force-download` is specified (`false` by default), network access to a Nexus instance is required. Otherwise, downloads are idempotent even if no outbound networking is allowed (on initial download, the Nexus metadata is cached in the `sha1.yml` file which is re-used on subsequent installation if no outbound networking is allowed -- by default, KPM will try to get the latest metadata from Nexus though)
[[gh-packages]]
### GitHub Packages
-KPM was initially designed to work against Sonatype. Starting with version 0.9.0, experimental support for GitHub packages has been added:
+Starting with version 0.9.0, experimental support for GitHub packages has been added:
....
kpm install_java_plugin acme:plugin \
--overrides url:https://maven.pkg.github.com/acme/plugin token:<TOKEN> \
--group-id com.acme \
--artifact-id plugin \
--version 0.0.1
....
Replace `TOKEN` with a GitHub personal access token.
+
+[[cloudsmith]]
+### Cloudsmith
+
+Starting with version 0.10.0, experimental support for Cloudsmith has been added:
+
+....
+kpm pull_kb_server_war 0.22.21-SNAPSHOT \
+ --overrides url:https://dl.cloudsmith.io/<TOKEN>/<ORG>/<REPO>/maven \
+ --group-id org.kill-bill.billing \
+ --artifact-id killbill-profiles-killbill
+....
+
+Replace `TOKEN` with a Cloudsmith entitlement token, and specify the right `ORG` and `REPO`.