Update readme

This commit is contained in:
David Parker
2021-09-13 10:04:00 -06:00
parent 99245c38e2
commit 864694a97e
+33 -3
View File
@@ -1,4 +1,34 @@
# Documentation
# ngrok API client library for Ruby
This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
easier to consume in Ruby.
## Installation
This library is published on [Rubygems](https://rubygems.org/gems/TODO)
```ruby
gem install TODO
```
## Documentation
A quickstart guide and a full API reference are included in the [ngrok Ruby API documentation](https://ruby-api.docs.ngrok.com)
## Quickstart
Please consult the [documentation](https://python-api.docs.ngrok.com) for additional examples.
```ruby
require 'ngrokapi/client'
client = NgrokAPI::Client.new(api_key: '<API KEY>')
# Get an instance of the api_keys client and list all API keys
keys = client.api_keys
keys.list
```
## Local Documentation
Documentation can be generated with the command:
@@ -8,7 +38,7 @@ yard doc 'lib/**/*.rb'
This will generate a documentation which can be viewed within the doc folder.
# Specs
## Specs
Specs can be run with the command:
@@ -18,7 +48,7 @@ bundle exec rake
This will generate a coverage report which can be viewed within the coverage folder.
# Rubocop
## Rubocop
Rubocop can be run with the command: