Skip to content

Commit c07268d

Browse files
committed
Documentation
1 parent 0a84272 commit c07268d

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ There are many ways to get started with halOP, but essentially there are two way
3030

3131
### Bundled
3232

33-
In this mode halOP is bundled with WildFly and can be used out of the box. halOP is available as an experimental feature pack
33+
In this mode halOP is bundled with WildFly and can be used out of the box. halOP is available as an
34+
experimental [feature pack](https://central.sonatype.com/artifact/org.jboss.hal/hal-op-feature-pack)
3435
that can be provisioned with [Galleon](https://github.com/wildfly/galleon). The feature pack mounts an additional HTTP endpoint
3536
on the management interface at http://localhost:9990/halop.
3637

@@ -91,7 +92,7 @@ op/standalone/target/hal-op-standalone-0.2.3-runner
9192
Please make sure that you have a recent version of GraalVM installed.
9293
See https://quarkus.io/guides/building-native-image#configuring-graalvm for details.
9394
94-
#### Latest release (JVM)
95+
#### Use the latest release (JVM)
9596
9697
The latest release is deployed as Uber-Jar using the `runner` classifier to Maven Central: [
9798
`org.jboss.hal:hal-op-standalone:0.2.3`](https://central.sonatype.com/artifact/org.jboss.hal/hal-op-standalone). You can
@@ -102,7 +103,7 @@ mvn dependency:copy -Dartifact=org.jboss.hal:hal-op-standalone:0.2.3:jar:runner
102103
java -jar hal-op-standalone-0.2.3-runner.jar
103104
```
104105
105-
#### Latest release (native)
106+
#### Use the latest release (native)
106107
107108
Native binaries for Linux, macOS, and Windows are attached to every [release](https://github.com/hal/foundation/releases).
108109
Download the binary for your platform, make it executable, and run it. To make the binary executable, you might need to run
@@ -115,13 +116,27 @@ xattr -d com.apple.quarantine hal-op-*
115116
116117
#### JBang
117118
118-
halOP is also available as
119-
a [JBang](https://jbang.dev/) [catalog](https://www.jbang.dev/documentation/jbang/latest/alias_catalogs.html#catalogs):
119+
halOP can also be started using [JBang](https://jbang.dev/).
120+
121+
```shell
122+
jbang org.jboss.hal:hal-op-standalone:0.2.2:runner
123+
```
124+
125+
If you want it even simpler, you can make use of
126+
the [JBang catalog](https://www.jbang.dev/documentation/jbang/latest/alias_catalogs.html#catalogs) for halOP:
120127
121128
```shell
122129
jbang hal-op@hal
123130
```
124131
132+
Finally, you can also install it as a command using `jbang app install hal-op@hal`. Then all you have to do is to run
133+
134+
```shell
135+
hal-op
136+
```
137+
138+
and you'll always be up to date.
139+
125140
#### Container
126141

127142
halOP is also available as a container image at https://quay.io/repository/halconsole/hal-op.

0 commit comments

Comments
 (0)