mirror of
https://github.com/bumi/openalias-ruby
synced 2025-06-16 06:58:13 +00:00
bumi
d3f471792b
Openalias.org is great! There is openalias.rs (written in Rust) to lookup and parse OpenAlias data. This is a ruby wrapper around that rust library. I don't know what I am doing so use at your own risk..and with care.
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# Openalias
|
|
|
|
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.
|
|
|
|
TODO: Delete this and the text above, and describe your gem
|
|
|
|
## Installation
|
|
|
|
Add this line to your application's Gemfile:
|
|
|
|
```ruby
|
|
gem 'openalias'
|
|
```
|
|
|
|
And then execute:
|
|
|
|
$ bundle
|
|
|
|
Or install it yourself as:
|
|
|
|
$ gem install openalias
|
|
|
|
## Usage
|
|
|
|
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]/openalias.
|
|
|
|
## License
|
|
|
|
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|