diff --git a/README.md b/README.md index 88aff88..d57dd97 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Lnrpc -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lnrpc`. To experiment with that code, run `bin/console` for an interactive prompt. +gRPC service definitions for lnd packed as ruby gem. -TODO: Delete this and the text above, and describe your gem +currently highly experimental and subject to change. ## Installation @@ -24,15 +24,9 @@ Or install it yourself as: TODO: Write usage instructions here -## Development - -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). - ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lnrpc. +Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/lnrpc. ## License