README.md in libra_client-0.1.1 vs README.md in libra_client-0.1.2

- old
+ new

@@ -1,10 +1,9 @@ # LibraClient -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/libra_client`. To experiment with that code, run `bin/console` for an interactive prompt. +LibraClient is an unofficial client for [Libra blockchain](http://libra.org). The library allows Ruby program to interact with Libra nodes with [protobuf](https://developers.google.com/protocol-buffers/) message through [grpc](https://grpc.io/). -TODO: Delete this and the text above, and describe your gem ## Installation Add this line to your application's Gemfile: @@ -23,30 +22,27 @@ ## Usage ```ruby require 'libra_client' -LibraClient.get_transaction(0) #get the genesis transaction -LibraClient.get_transaction(1) #get the first transaction -version = LibraClient.get_latest_transaction_version -LibraClient.get_transaction(version) #get the latest transaction +client = Libra::Client.new(:testnet) +client.get_transaction(0) #get the genesis transaction +client.get_transaction(1) #get the first transaction +version = client.get_latest_transaction_version +client.get_transaction(version) #get the latest transaction -LibraClient.get_account_state(ASSOCIATION_ADDRESS) +client.get_account_state(ASSOCIATION_ADDRESS) ``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/libra_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/yuanxinyu/libra_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). - -## Code of Conduct - -Everyone interacting in the LibraClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/libra_client/blob/master/CODE_OF_CONDUCT.md).