twirp-ruby/README.md

# Twirp-Ruby

[![Run Tests](https://github.com/github/twirp-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/github/twirp-ruby/actions/workflows/tests.yml)

[Twirp is a protocol](https://github.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.

The [canonical implementation](https://github.com/github/twirp) is in Golang. The Twirp-Ruby project is the official implementation in Ruby for both server and clients.


## Install

Add `gem "twirp"` to your Gemfile, or install with `gem install twirp`.

To auto-generate Ruby code from a proto file, use the `protoc` plugin and the `--ruby_out` option ([see Wiki page](https://github.com/github/twirp-ruby/wiki/Code-Generation)).


## Documentation

[On the wiki](https://github.com/github/twirp-ruby/wiki).


## Contributing

[On the CONTRIBUTING file](CONTRIBUTING.md).

### Releases and changes

See the [releases](https://github.com/github/twirp-ruby/releases) page for latest information about released versions.
Simplify README with links to the wiki 2018-05-23 02:23:10 +03:00			`# Twirp-Ruby`
Edit gemspec and add initial files 2018-02-05 05:26:55 +03:00
s/twitchtv/github Github org is now maintaining this project 2023-01-05 16:55:21 +03:00			`[![Run Tests](https://github.com/github/twirp-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/github/twirp-ruby/actions/workflows/tests.yml)`
Adds test status to the README Making it easier to see test status at a glance. 2022-06-07 18:21:27 +03:00
s/twitchtv/github Github org is now maintaining this project 2023-01-05 16:55:21 +03:00			`[Twirp is a protocol](https://github.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.`
Update README with clients 2018-04-07 03:01:38 +03:00
s/twitchtv/github Github org is now maintaining this project 2023-01-05 16:55:21 +03:00			`The [canonical implementation](https://github.com/github/twirp) is in Golang. The Twirp-Ruby project is the official implementation in Ruby for both server and clients.`
added README + examples 2018-02-06 09:22:17 +03:00
small edits to the README file 2018-05-23 02:48:10 +03:00
Improve README file 2018-04-09 06:51:58 +03:00			`## Install`
edit README 2018-03-13 22:03:01 +03:00
Simplify README with links to the wiki 2018-05-23 02:23:10 +03:00			Add `gem "twirp"` to your Gemfile, or install with `gem install twirp`.
Twirp service handlers receive the input message and also a Twirp environment that can be used to read headers from the request, environment data from before hooks and also set headers for the response 2018-02-22 05:38:23 +03:00
s/twitchtv/github Github org is now maintaining this project 2023-01-05 16:55:21 +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/github/twirp-ruby/wiki/Code-Generation)).
Update Readme 2019-12-31 02:11:19 +03:00
Edit README 2018-04-11 02:27:24 +03:00
Simplify README with links to the wiki 2018-05-23 02:23:10 +03:00			`## Documentation`
Edit README 2018-04-11 02:27:24 +03:00
s/twitchtv/github Github org is now maintaining this project 2023-01-05 16:55:21 +03:00			`[On the wiki](https://github.com/github/twirp-ruby/wiki).`
Release v1.1.0 2018-09-17 21:34:40 +03:00

			`## Contributing`

Update Readme 2019-12-31 02:11:19 +03:00			`[On the CONTRIBUTING file](CONTRIBUTING.md).`
add info about version 2 on readme 2023-01-05 16:44:58 +03:00
Add doc about releases page 2023-01-05 17:01:15 +03:00			`### Releases and changes`
add info about version 2 on readme 2023-01-05 16:44:58 +03:00
Add doc about releases page 2023-01-05 17:01:15 +03:00			`See the [releases](https://github.com/github/twirp-ruby/releases) page for latest information about released versions.`