Added additional documentation for the API. #13

	name: Branch Checks

	on:
	push:
	branches-ignore:
	- main

	jobs:
	lint:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4
	- run: git fetch origin main --depth=1
	- name: RuboCop Linter
	uses: andrewmcodes/[email protected]
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

	spec:
	runs-on: ubuntu-latest
	env:
	COVERAGE: 1

	steps:
	- uses: actions/checkout@v4
	- name: Set up Ruby
	uses: ruby/setup-ruby@v1
	with:
	# runs 'bundle install' and caches installed gems automatically
	bundler-cache: true
	- name: Run tests
	run: bundle exec rspec

Provide feedback