Design updates with error handling

This commit is contained in:
bterkuile committed 2025-10-18 09:13:12 -05:00
1 parent 4c73608549
commit 4b84df0af9
9 files changed
+124 -38

No files matched your search

+23 -4
View File
@@ -1,8 +1,11 @@
# StrikeMe::API
StrikeMe::API
==============
This is a ruby gem to interact with the strike.me API. It is an inition proof of concept implementation.
As a reference, the documentation of the [Strike API](https://docs.strike.me/api)
## Installation
Installation
-------------
TODO: Replace `strike_me-api` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
@@ -18,9 +21,25 @@ If bundler is not being used to manage dependencies, install the gem by executin
gem install strike_me-api
```
## Usage
Playground
-----------------
To play around with this api you can start a REPL using one of the following commands from the project's root:
```bash
pry -r strike_me/api
# or
irb -I lib -r strike_me/api
```
Then type code like:
```ruby
account = StrikeMe::API::Account.new
account.profile.attributes
account.balances.map(&:attributes)
```
TODO: Write usage instructions here
Usage
--------------
TODO: Write usage instructions here, for now, look at Playground
## Development