1
0
mirror of https://github.com/bumi/lnrpc synced 2025-06-24 15:40:27 +00:00

Add versioning note to readme

This commit is contained in:
bumi 2019-05-15 11:49:35 +02:00
parent 990f0f5987
commit 870adaf546

View File

@ -2,16 +2,16 @@
a [gRPC](https://grpc.io/) client for [LND, the Lightning Network Daemon](https://github.com/lightningnetwork/lnd/) packed as ruby gem. a [gRPC](https://grpc.io/) client for [LND, the Lightning Network Daemon](https://github.com/lightningnetwork/lnd/) packed as ruby gem.
Currently published as [beta release](https://rubygems.org/gems/lnrpc) to rubygems for LND v0.5.2.beta. (see [#Versioning](#Versioning))
## Installation ## Installation
Add this line to your application's Gemfile: Add this line to your application's Gemfile:
```ruby ```ruby
gem 'lnrpc' gem 'lnrpc', '~> 0.6.1'
``` ```
lnrpc follows the lnd versioning, thus it is recommended to specify the exact version you need for your lnd node as dependency (see [#Versioning](#Versioning)).
And then execute: And then execute:
@ -140,6 +140,8 @@ Don't have a BTC Pay Server? [Setting one up is easy.](https://medium.com/@Btcpa
This gem follows the LND versions and will update the gRPC service definitions accordingly. This gem follows the LND versions and will update the gRPC service definitions accordingly.
e.g. gem version 0.5.2 includes the gRPC service definitions from LND v0.5.2 e.g. gem version 0.5.2 includes the gRPC service definitions from LND v0.5.2
see [rubygems](https://rubygems.org/gems/lnrpc) for all available releases.
### Update service definitions ### Update service definitions