riffer 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a36bd54b70a03d93c4b955823477288bb7a52fc7f2be090dad466b8aa1ef5dd
-  data.tar.gz: 2d305b20b5f85dc3dfdb632624849cc83e9abc049739c703f03da1661fe342e8
+  metadata.gz: bb60a1ab6edf223c701c1b3ff1af14a6ff52520541d1d5e757df963436517402
+  data.tar.gz: 723b875438e9d787f7199d8ee8d83d8485dfed47686e85e2c43c221a0482c41e
 SHA512:
-  metadata.gz: 3d82cd6aff279eb94ff710c7c7d3462a81f17a97d93f19c6df9d93cc83749e0d30ac5e8956b4e802ac2e2097c5c816f315a8027be47ce98ed16e7382d1937437
-  data.tar.gz: e4d964bc0c1ad34c29639c8ba4a9b5b28a62376608d8b9b4e383127bf55d0948795a820f00f80ee3b71e2bbda61e78b5b6e6f4fc91534058f7069ad1fca3f025
+  metadata.gz: e288711d911bbf4803f770afccf95685067496d0b1443a31ab8f0291ee3a9e58deac4215820e8e261e8966fac9c14f749880d0b07e47b41458d4801406ad75b1
+  data.tar.gz: a877dc42d6e07d0f31ca95213603a44fb47d865ea0e1b69ffad8cc898e69f3cce4e96ae6c750d4fe70c0e5e85a1c7efb7bb870c905306db1b67ea0d39adbbb82

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.4.1"
+  ".": "0.4.2"
 }

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.2](https://github.com/bottrall/riffer/compare/riffer/v0.4.1...riffer/v0.4.2) (2025-12-29)
+
+
+### Bug Fixes
+
+* update README for clarity on provider usage and examples ([#60](https://github.com/bottrall/riffer/issues/60)) ([b12835c](https://github.com/bottrall/riffer/commit/b12835ce71c29e02074a0897551db50283ac8be6))
+
 ## [0.4.1](https://github.com/bottrall/riffer/compare/riffer/v0.4.0...riffer/v0.4.1) (2025-12-29)
 
 

data/README.md

@@ -17,7 +17,7 @@ Key concepts:
 ## Features
 
 - Minimal, well-documented core for building AI agents
-- Provider abstraction (OpenAI + test provider) for easy testing
+- Provider abstraction (OpenAI) for pluggable providers
 - Streaming support and structured stream events
 - Message converters and helpers for robust message handling
 
@@ -47,46 +47,34 @@ gem 'riffer', git: 'https://github.com/bottrall/riffer.git'
 
 ## Quick Start
 
-Basic usage with the built-in test provider:
+Basic usage with the OpenAI provider:
 
 ```ruby
 require 'riffer'
 
+# Configure OpenAI API key (recommended to use ENV)
+Riffer.configure do |config|
+  config.openai.api_key = ENV['OPENAI_API_KEY']
+end
+
 class EchoAgent < Riffer::Agent
   identifier 'echo'
-  model 'test/default' # provider/model
+  model 'openai/gpt-5-mini' # provider/model
   instructions 'You are an assistant that repeats what the user says.'
 end
 
 agent = EchoAgent.new
 puts agent.generate('Hello world')
-# => "Test response" (the test provider returns a canned response by default)
+# => "Hello world"
 ```
 
-Using the test provider directly (useful for unit tests):
+Streaming example (OpenAI):
 
 ```ruby
-provider = Riffer::Providers::Test.new
-provider.stub_response('Hello from test provider!')
-assistant = provider.generate_text(prompt: 'Say hi')
-puts assistant.content # => "Hello from test provider!"
-```
-
-Streaming example (provider-dependent):
-
-```ruby
-provider = Riffer::Providers::Test.new
-enum = provider.stream_text(prompt: 'Stream something')
+provider = Riffer::Providers::OpenAI.new
+enum = provider.stream_text(prompt: 'Stream something', model: 'gpt-4')
 enum.each do |chunk|
-  puts chunk[:content]
-end
-```
-
-Configuration example (OpenAI API key):
-
-```ruby
-Riffer.configure do |config|
-  config.openai.api_key = ENV['OPENAI_API_KEY']
+  puts chunk.content
 end
 ```
 
@@ -136,7 +124,3 @@ Licensed under the MIT License. See `LICENSE.txt` for details.
 ## Maintainers
 
 - Jake Bottrall — https://github.com/bottrall
-
----
-
-If you'd like, I can add short usage examples to the documentation site or update the gemspec metadata (authors, homepage, summary).

data/lib/riffer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riffer
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riffer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Jake Bottrall