README.md in zeebe-client-0.1.0 vs README.md in zeebe-client-0.2.0

- old
+ new

@@ -1,8 +1,8 @@ # Zeebe Ruby Client -[![Build Status](https://travis-ci.org/cmur2/zb-ruby-client.svg?branch=master)](https://travis-ci.org/cmur2/zb-ruby-client) +[![Build Status](https://travis-ci.org/zeebe-io/zeebe-client-ruby.svg?branch=master)](https://travis-ci.org/zeebe-io/zeebe-client-ruby/) [Zeebe](https://zeebe.io) client containing a simple wrapper for the GRPC protocol used by Zeebe. ## General Usage @@ -11,15 +11,43 @@ gem install zeebe-client Run a Zeebe instance locally: ```sh -docker run -it --rm -p 26500:26500 camunda/zeebe:0.13.1 +docker run -it --rm -p 26500:26500 camunda/zeebe:0.14.0 ``` And then try the available [demo script](examples/demo.rb). See the [changelog](CHANGELOG.md) before upgrading. ## Development The `gen-grpc.sh` script can be used to generate Ruby code for the Zeebe proto. + +To start Zeebe locally for running the integration tests use: + +```sh +bundle exec rake zeebe:start +bundle exec rake spec +bundle exec rake zeebe:stop +``` + +To retrieve the latest GRPC proto from the Zeebe repository: + +```sh +wget -O proto/gateway.proto https://raw.githubusercontent.com/zeebe-io/zeebe/develop/gateway-protocol/src/main/proto/gateway.proto +``` + +## Status + +This is a community extension for [Zeebe](https://zeebe.io) that will be maintained on a best effort basis. + +## License + +zeebe-client-ruby is licensed under the Apache License, Version 2.0. See LICENSE for more information. + +## Code of Conduct + +This project adheres to the Contributor Covenant [Code of +Conduct](/CODE_OF_CONDUCT.md). By participating, you are expected to uphold +this code. Please report unacceptable behavior to code-of-conduct@zeebe.io.