Skip to content

Commit

Permalink
Update installation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
iamazeem committed Aug 11, 2023
1 parent 7ef273e commit dc8e1b1
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit dc8e1b1

Please sign in to comment.