Release v1.0.3

Author: sborsje

CHANGELOG.md

@@ -5,7 +5,7 @@ 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).
 
-## [1.0.2] - 2025-12-04
+## [1.0.3] - 2025-12-04
 
-Updated examples in the README
+Update documentation
 

README.md

@@ -43,7 +43,13 @@ client.track('Button Clicked', {
   plan: 'pro'
 }, user_id: 'user_123')
 
-# Associate a user with a group
+# Associate user with a group and set group traits
+client.group('org_456', {
+  name: 'Acme Inc',
+  plan: 'enterprise'
+}, user_id: 'user_123')
+
+# Or just link the user to a group (if traits are already set)
 client.group('org_456', user_id: 'user_123')
 
 # Shutdown gracefully
@@ -74,19 +80,20 @@ Klime::Client.new(
 Track a user event. A `user_id` is required for events to be useful in Klime.
 
 ```ruby
-# Basic usage
 client.track('Button Clicked', {
   button_name: 'Sign up',
   plan: 'pro'
 }, user_id: 'user_123')
 
-# With group context and IP
+# With IP address (for geolocation)
 client.track('Button Clicked', {
   button_name: 'Sign up',
   plan: 'pro'
-}, user_id: 'user_123', group_id: 'org_456', ip: '192.168.1.1')
+}, user_id: 'user_123', ip: '192.168.1.1')
 ```
 
+> **Advanced**: The `group_id` parameter is available for multi-tenant scenarios where a user belongs to multiple organizations and you need to specify which organization context the event occurred in.
+
 #### `identify(user_id, traits = nil, ip: nil)`
 
 Identify a user with traits.
@@ -100,22 +107,23 @@ client.identify('user_123', {
 
 #### `group(group_id, traits = nil, user_id: nil, ip: nil)`
 
-Register a group or associate a user with a group.
-
-**Without `user_id`**: Register or update group metadata. Use this when you want to set or update properties on a group (e.g., company name, plan, industry).
+Associate a user with a group and/or set group traits.
 
 ```ruby
+# Associate user with a group and set group traits (most common)
 client.group('org_456', {
   name: 'Acme Inc',
-  plan: 'enterprise',
-  industry: 'Technology'
-})
-```
-
-**With `user_id`**: Associate a user with a group. Use this to link users to their organization. Keep it simple—no traits needed.
+  plan: 'enterprise'
+}, user_id: 'user_123')
 
-```ruby
+# Just link a user to a group (traits already set or not needed)
 client.group('org_456', user_id: 'user_123')
+
+# Just update group traits (e.g., from a webhook or background job)
+client.group('org_456', {
+  plan: 'enterprise',
+  employee_count: 50
+})
 ```
 
 #### `flush`

klime.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "klime"
-  spec.version       = "1.0.2"
+  spec.version       = "1.0.3"
   spec.authors       = ["Klime"]
   spec.email         = ["[email protected]"]
 

lib/klime/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Klime
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end