diff options
Diffstat (limited to 'upb/bindings/ruby/README.md')
| -rw-r--r-- | upb/bindings/ruby/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/upb/bindings/ruby/README.md b/upb/bindings/ruby/README.md new file mode 100644 index 0000000..12a7169 --- /dev/null +++ b/upb/bindings/ruby/README.md @@ -0,0 +1,30 @@ + +# Ruby extension + +To build, run (from the top upb directory): + + $ make ruby + $ sudo make install + +To test, run: + + $ make rubytest + +The binding currently supports: + + - loading message types from descriptors. + - constructing message instances + - reading and writing their members + - parsing and serializing the messages + - all data types (including nested and repeated) + +The binding does *not* currently support: + + - defining message types directly in Ruby code. + - generating Ruby code for a .proto file. + - type-checking for setters + - homogenous / type-checked arrays + - default values + +Because code generation is not currently implemented, the interface to import +a specific message type is kind of clunky for the moment. |