Skip to content

Commit 0453ec3

Browse files
authored
README: update
1 parent ea1a979 commit 0453ec3

1 file changed

Lines changed: 20 additions & 13 deletions

File tree

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
# Blockfrostruby
1+
[![Gem Version](https://badge.fury.io/rb/blockfrost-ruby.svg)](https://rubygems.org/gems/blockfrost-ruby) <a href="https://fivebinaries.com/"><img src="https://img.shields.io/badge/made%20by-Five%20Binaries-darkviolet.svg?style=flat-square" /></a>
22

3-
Ruby SDK to work with Blockfrost (Cardano Blockchain API)
4-
Blockfrost is a hosted API as a service serving the data from the Cardano blockchain.
5-
This gem is Ruby SDK for Blockfrost.io to enable developers
6-
to use full power of this API without having to create basic functions for it.
7-
The OpenAPI documentation is hosted at https://github.com/blockfrost/openapi.\
8-
This gem is licensed under ASL 2.0.
3+
<img src="https://blockfrost.io/images/logo.svg" width="250" align="right" height="90">
4+
5+
# blockfrost-ruby
6+
7+
<br/>
8+
9+
<p align="center">Ruby SDK for <a href="https://blockfrost.io">Blockfrost.io</a> API.</p>
10+
<p align="center">
11+
<a href="#installation">Installation</a> •
12+
<a href="#usage">Usage</a> •
13+
<a href="#development">Development</a>
14+
</p>
15+
<br>
916

10-
More information about using this API can be found on https://docs.blockfrost.io/
1117
## Installation
1218

13-
For now, it's not hosted on a RubyGems,
14-
so you can install this SDK only from this repo.
19+
You can download the latest release directly from rubygems.org:
20+
21+
$ gem install blockfrost-ruby
1522

16-
To do this, download this repo to your machine, then go to the directory:
23+
To build the current master, download this repo to your machine, then go to the directory:
1724

18-
$ cd path-to-dir-with-this-repo
25+
$ cd blockfrost-ruby
1926

2027
And run next commands:
2128

@@ -131,4 +138,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
131138

132139
## Contributing
133140

134-
Bug reports and pull requests are welcome on GitHub at https://github.com/blockfrost/blockfrostruby.
141+
Bug reports and pull requests are welcome on GitHub at https://github.com/blockfrost/blockfrost-ruby.

0 commit comments

Comments
 (0)