Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
loafoe authored Mar 18, 2024
1 parent dd10613 commit c5719f4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# siderite
siderite is a companion tool to the iron CLI to make the interaction with the HSDP Iron service more pleasant. It can both prepare the payloads for your tasks and also act as a runner in your dockerized workload to interpret the payload.
siderite is a companion tool to the iron CLI to make the interaction with the Iron.io service more pleasant. It can both prepare the payloads for your tasks and also act as a runner in your dockerized workload to interpret the payload.

# requirements
* IronCLI - https://dev.iron.io/worker/reference/cli/
* CF CLI - https://docs.cloudfoundry.org/cf-cli/install-go-cli.html
* Access to HSDP CF
* Access to Cloud foundyr

# install siderite binary
Ensure you have [Go 1.21 or newer](https://golang.org/dl/) installed, then:
Expand All @@ -14,7 +14,7 @@ $ go install github.com/philips-labs/siderite@latest
```

# configuration
next you need to have a HSDP Iron instances provisioned through the HSDP Iron broker. The service details of this instance should be in your home folder as `~/.iron.json`. This can be done using the sequence of commands shown below:
next you need to have a Iron.io instances provisioned through the HSDP Iron broker. The service details of this instance should be in your home folder as `~/.iron.json`. This can be done using the sequence of commands shown below:

```shell
$ cf cs hsdp-iron dev-large-encrypted iron
Expand Down

0 comments on commit c5719f4

Please sign in to comment.