From dbae3e1e8731fbc462e4b404a3b4e68ceefe28af Mon Sep 17 00:00:00 2001 From: bumi Date: Thu, 1 Nov 2018 02:24:11 +0100 Subject: [PATCH] Readme --- README.md | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e1cfa17..70f58ae 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ -# Openalias +# OpenAlias ruby -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/openalias`. To experiment with that code, run `bin/console` for an interactive prompt. +This ruby gem allows you to lookup and read [OpenAlias](https://openalias.org) data with ruby. -TODO: Delete this and the text above, and describe your gem +OpenAlias ([openalias.org](https://openalias.org)) is an open standard for simpler addresses for any crypto currencies. [Read more here](https://openalias.org) + + At its most basic, OpenAlias is a TXT DNS record on a FQDN (fully qualified domain name). + By combining this with DNS-related technologies [it has] created an aliasing standard that is extensible for developers, + intuitive and familiar for users, and can interoperate with both centralised and decentralised domain systems. + +It is using the [OpenAlias rust implementation](https://github.com/nabijaczleweli/openalias.rs/) - and is simply a ruby wrapper with a native rust extension. + +Maybe this is a bad idea, but I had a few minutes and wanted to try it. It works perfectly (but gem install takes a while to compile the extension) +At some point it would probably be awesome to rewrite the whole thing in pure ruby - which is likely very easy. ## Installation @@ -12,27 +21,27 @@ Add this line to your application's Gemfile: gem 'openalias' ``` -And then execute: - - $ bundle - Or install it yourself as: $ gem install openalias ## Usage -TODO: Write usage instructions here +```ruby +Openalias.addresses('btc@michaelbumann.com') +=> [#] -## Development +Openalias.addresses('donate.getmonero.org') +=> [#, #] -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. +Openalias.addresses('donate.getmonero.org')[0].recipient_name +=> "Monero Development" -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]/openalias. +Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/openalias-ruby. ## License