Skip to content

Commit

Permalink
Add links to released gem and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
r-n-o committed Feb 22, 2024
1 parent f9b341f commit 3c7a4ff
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Turnkey Ruby SDK

This repository contains a Ruby gem (`turnkey_client`) to interact with Turnkey.
[![CI](https://github.com/tkhq/ruby-sdk/actions/workflows/rubocop.yml/badge.svg)](https://github.com/tkhq/ruby-sdk/actions/workflows/rubocop.yml) [![Gem Version](https://img.shields.io/gem/v/turnkey_client.svg)](https://rubygems.org/gems/turnkey_client)

This repository contains a Ruby gem, [`turnkey_client`](https://rubygems.org/gems/turnkey_client) to interact with the Turnkey API.

## Using Turnkey in your Ruby projects

Expand All @@ -10,7 +12,7 @@ To install `turnkey_client`, install it with bundler:
bundle install turnkey_client
```

Then `require` it in Ruby files and use it:
Then `require` it in Ruby files to use it:

```rb
require "turnkey_client"
Expand Down Expand Up @@ -69,7 +71,7 @@ If you want to tweak something related to codegen itself, head ([here](./turnkey

If you want to update templates with upstream this is a bit harder but possible: these templates were downloaded from [this folder](https://github.com/swagger-api/swagger-codegen-generators/tree/0f7eeb2ca53e5fff886ce1a609bce1b1e75063fe/src/main/resources/handlebars/ruby) (this is a permalink to the right git SHA). You can see all the changes made to these by looking at the history of changes in the templates folder: https://github.com/tkhq/ruby-sdk/commits/main/turnkey_client_inputs/templates.

# Rubocop
## Rubocop

We use Rubocop for linting. To install:

Expand All @@ -82,3 +84,13 @@ And run:
```sh
$ rubocop
```

## Releasing on Rubygems.org

To build and release:

```sh
$ cd turnkey_client
$ gem build turnkey_client.gemspec
$ gem push turnkey_client-x.y.z.gem
```
2 changes: 1 addition & 1 deletion examples/signing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Who am I?

This examples shows how to use `turnkey_client` to create a new wallet and sign a message with it.
This examples shows how to use [`turnkey_client`](https://rubygems.org/gems/turnkey_client) to create a new wallet and sign a message with it.

To run this example:
* `cp .env.example .env`
Expand Down
2 changes: 1 addition & 1 deletion examples/whoami/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Who am I?

This examples shows how to use `turnkey_client` to sign requests. Here we sign a "Who am I?" request (see [documentation](https://docs.turnkey.com/api#tag/Sessions/operation/GetWhoami))
This examples shows how to use [`turnkey_client`](https://rubygems.org/gems/turnkey_client) to sign requests. Here we sign a "Who am I?" request (see [documentation](https://docs.turnkey.com/api#tag/Sessions/operation/GetWhoami))

To run this example:
* `cp .env.example .env`
Expand Down

0 comments on commit 3c7a4ff

Please sign in to comment.