From dc8e1b15364499865db4c786ecd375f1554029e3 Mon Sep 17 00:00:00 2001 From: Azeem Sajid Date: Fri, 11 Aug 2023 15:49:45 +0500 Subject: [PATCH] Update installation instructions. --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 325ed8f..0bf0e06 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,17 @@ Install `proto-convert` with [RubyGems](https://rubygems.org/pages/download): gem install proto-convert ``` +Depending on your installed Ruby version, the latest `google-protobuf` may not +install due to compatibility issues. You need to install the older version +yourself or you may choose to upgrade to a later Ruby version. + +It has also been observed that the installed `protoc` and `google-protobuf` gem +may be incompatible and may result into compilation failure of the `input` +file on runtime. + +- For Ruby 2.6, `protoc` v3.17.3 and `google-protobuf` v3.12 work fine. +- For Ruby 2.7 and later, the latest versions of both should work fine. + ## Usage Run `proto-convert -h` for usage help. @@ -86,12 +97,6 @@ $ cat test.json {"id":123,"body":"test"} ``` -## Known Issues - -- It has been observed that the installed `protoc` and `google-protobuf` gem - may be incompatible and may result into compilation failure of the `input` - file. - ## Contribute - [Fork](https://github.com/iamazeem/proto-convert/fork) the project.