bumi/openalias-ruby
1
0
Fork 0
mirror of https://github.com/bumi/openalias-ruby synced 2025-06-16 06:58:13 +00:00
Code Issues Releases Wiki Activity

Readme

Browse Source
This commit is contained in:
bumi 2018-11-01 02:24:11 +01:00
parent d3f471792b
commit dbae3e1e87
1 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -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')
=> [#<Openalias::CryptoAddress cryptocurrency="btc", address="3MGfEx4iaVEAy8nD4rWdocgrPo8aCR4Zfa", recipient_name="bumi">]
## Development
Openalias.addresses('donate.getmonero.org')
=> [#<Openalias::CryptoAddress cryptocurrency="xmr", address="44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A", recipient_name="Monero Development", tx_description="Donation to Monero Core Team">, #<Openalias::CryptoAddress cryptocurrency="btc", address="1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H", recipient_name="Monero Development", tx_description="Donation to Monero Core Team">]
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