Contents

# Shelby Arena Ruby Client ![example workflow](https://github.com/taylorbrooks/shelby_arena/actions/workflows/test.yml/badge.svg)

A Ruby wrapper for the Shelby Arena API

### Installation
Add this line to your application's Gemfile:
````ruby
  # in your Gemfile
  gem 'shelby_arena', '~> 0.0.1'

  # then...
  bundle install
````

### Usage
````ruby
  # Authenticating with username and password
  client = ShelbyArena::Client.new(
    url: ...,
    username: ...,
    password: ...,
  )

  # Find a people by attributes
  client.find_people_by_email('[e-mail]')
  client.find_people_by_name_and_email('Tobias', 'Funke', '[e-mail]')
````

### History

- View the [changelog](https://github.com/taylorbrooks/shelby_arena/blob/master/CHANGELOG.md)
- This gem follows [Semantic Versioning](http://semver.org/)

### Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

- [Report bugs](https://github.com/taylorbrooks/shelby_arena/issues)
- Fix bugs and [submit pull requests](https://github.com/taylorbrooks/shelby_arena/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features

### Copyright
Copyright (c) 2023 Taylor Brooks. See LICENSE for details.

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
shelby_arena-0.0.8	README.md
shelby_arena-0.0.7	README.md
shelby_arena-0.0.6	README.md
shelby_arena-0.0.5	README.md
shelby_arena-0.0.4	README.md
shelby_arena-0.0.3	README.md
shelby_arena-0.0.2	README.md
shelby_arena-0.0.1	README.md