Skip to content

Commit 77a3337

Browse files
authored
Update README.md
1 parent ddd7f2a commit 77a3337

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ Browse the [wiki pages](https://github.com/balis/hyperflow/wiki) to learn more a
1313
### Installation
1414
* Install Node.js (http://nodejs.org)
1515
* Install Redis (http://redis.io)
16-
* Install HyperFlow: <br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/{version}.tar.gz` (where `{version}` is for example `v1.3.38`)
17-
* For latest features, install from the master branch: <br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/master.tar.gz`
18-
* Add `<install_root>/node_modules/.bin` to your path
16+
* Install HyperFlow:
17+
* From npm package: `npm install -g @hyperflow/hyperflow`
18+
* From github repository:<br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/{version}.tar.gz`<br>(where `{version}` is for example `v1.5.0`)
19+
* From the master branch: <br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/master.tar.gz`
1920

2021
### Running locally
2122
* Start the redis server: `redis-server`
@@ -40,7 +41,7 @@ docker run -a stdout -a stderr --rm --network container:redis \
4041
--entrypoint "/bin/sh" hyperflowwms/hyperflow -c "apk add docker && hflow run /wfdir"
4142
```
4243
Where
43-
* `hyperflowwms/soykb-workflow-worker` is the name of the workflow worker container ([Soykb](https://github.com/hyperflow-wms/soykb-workflow) in this case)
44+
* `hyperflowwms/soykb-worker` is the name of the workflow worker container ([Soykb](https://github.com/hyperflow-wms/soykb-workflow) in this case)
4445
* current directory contains `workflow.json`
4546
* subdirectory `inputs` contains workflow input data
4647

@@ -51,12 +52,13 @@ Outputs:
5152
### Running in a Kubernetes cluster
5253
See [HyperFlow Kubernetes deployment](https://github.com/hyperflow-wms/hyperflow-k8s-deployment) project for more information.
5354

54-
### Running in a distributed infrastructure using the RabbitMQ executor
55+
### Running in a distributed infrastructure using the RabbitMQ executor (not maintained)
5556
* Start the RabbitMQ container: `docker run -d --name rabbitmq rabbitmq:3`
5657
* Add option `-e AMQP_URL=amqp://rabbitmq`
57-
* More information in the [hyperflow-amqp-executor](https://github.com/hyperflow-wms/hyperflow-amqp-executor) project (warning: currently not maintained and not tested with latest HyperFlow versions)
58+
* More information in the [hyperflow-amqp-executor](https://github.com/hyperflow-wms/hyperflow-amqp-executor) project
59+
* **Warning**: currently not maintained and not tested with latest HyperFlow versions
5860

59-
### Local configuration files
61+
## Local configuration files
6062
You can provide workflow configuration through local configuration files:
6163
* `workflow.config.json` -- main configuration file
6264
* `workflow.config.{name}.json` -- any number of secondary configuration files
@@ -83,7 +85,7 @@ The following will be passed in `context.appConfig`:
8385
}
8486
```
8587

86-
### HyperFlow server
88+
## HyperFlow server
8789
The HyperFlow engine can be started in a server mode using command: ```hflow start-server```
8890

8991
If succesfully started, the server prints its URL:

0 commit comments

Comments
 (0)