twirp-ruby/README.md

31 строка
1.7 KiB
Markdown
Исходник Обычный вид История

2018-05-23 02:23:10 +03:00
# Twirp-Ruby
2018-02-05 05:26:55 +03:00
2023-06-13 04:21:47 +03:00
[![Run Tests](https://github.com/arthurnn/twirp-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/arthurnn/twirp-ruby/actions/workflows/tests.yml)
2023-01-08 16:23:09 +03:00
[Twirp is a protocol](https://twitchtv.github.io/twirp/docs/spec_v5.html) for routing and serialization of services defined in a [.proto file](https://developers.google.com/protocol-buffers/docs/proto3), allowing easy implementation of RPC services with auto-generated clients in different languages.
2018-04-07 03:01:38 +03:00
2023-01-05 17:19:49 +03:00
The [canonical implementation](https://github.com/twitchtv/twirp) is in Golang. The Twirp-Ruby project is the official implementation in Ruby for both server and clients.
2018-02-06 09:22:17 +03:00
2018-05-23 02:48:10 +03:00
2018-04-09 06:51:58 +03:00
## Install
2018-03-13 22:03:01 +03:00
2018-05-23 02:23:10 +03:00
Add `gem "twirp"` to your Gemfile, or install with `gem install twirp`.
2023-06-13 04:21:47 +03:00
To auto-generate Ruby code from a proto file, use the `protoc` plugin and the `--ruby_out` option ([see Wiki page](https://github.com/arthurnn/twirp-ruby/wiki/Code-Generation)).
2019-12-31 02:11:19 +03:00
2024-08-27 00:08:11 +03:00
### No backwards compatible breaking changes, between minor versions(1.10.0)
When upgrading from version 1.9.0 to 1.10.0, note that there is a breaking change in the `Twirp::ClientResp#initialize` method. The method now accepts keyword arguments. For more details, refer to this [comparison](https://github.com/arthurnn/twirp-ruby/compare/v1.9.0...v1.10.0#diff-b3c497150f4ae769df1a5d90e43142983cfd4d780392cbaa218d74912fa3a174) and this [issue](https://github.com/arthurnn/twirp-ruby/issues/99).
2018-04-11 02:27:24 +03:00
2018-05-23 02:23:10 +03:00
## Documentation
2018-04-11 02:27:24 +03:00
2023-06-13 04:21:47 +03:00
[On the wiki](https://github.com/arthurnn/twirp-ruby/wiki).
2018-09-17 21:34:40 +03:00
## Contributing
2019-12-31 02:11:19 +03:00
[On the CONTRIBUTING file](CONTRIBUTING.md).
2023-01-05 16:44:58 +03:00
2023-01-05 17:19:49 +03:00
## Releases and changes
2023-01-05 16:44:58 +03:00
2023-06-13 04:21:47 +03:00
See the [releases](https://github.com/arthurnn/twirp-ruby/releases) page for latest information about released versions.