livechat 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aee50137fc34157ea3fff75a2095055b4224c2d0ced2524ea13278135256b07f
-  data.tar.gz: 358aa67a9cb0a4b30ee961078cf4d8ae740da6fbbe04cbdcba987fc68c7e866f
+  metadata.gz: 89fb2589ac2b07d722d95c48bf0de22dcdcaa21ebcc8e691ffa4a3eb862fcd3d
+  data.tar.gz: cbb878a7a0c0794459468f3f857473ad1f29b6b92a477572be99797166eeefcf
 SHA512:
-  metadata.gz: 45f8656ac4857d04970159bfc75052b75da1152b993d83a4c7c743589cda5e78cf5e47c2de7607c2c94d4fafdce880c50dd36b02000dcc2ec1e4a16343c4821e
-  data.tar.gz: c7e6e959cd01488ca58a8e59ed943da3233d9e9e3b6670aac19be11915a8595e8ec680bac0b4ad262a19b755be42da7bbf16af007e56815fed7f8aaffd7e5683
+  metadata.gz: b9fc7e79282e70099732ac379632844d12601b61c438598f39551ed3fca91e635ce424c97786afd51ecdd18a814f10bab3c14d6fc53ad3f6bda54c22eeb78688
+  data.tar.gz: 14812aa4533f89bf621688036929e0d6bb9e13d2e9bef4339d59c83a62300ed3cefe5f382f928d8d91ab46cfc084a8a47e467adfa15d0ee43921c9cedf238264

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.6.1
+
+- Repositioned the docs around in-app support messaging for Rails: users ask
+  for help from the page where they got stuck, and teams answer from the
+  mounted inbox without SaaS, third-party scripts, or a separate support app.
+- Added `message:` to `livechat_button`, so contextual support buttons can open
+  the widget and prefill the composer in one helper call.
+- Updated the PRD to match the current shipped feature set through 0.6.0.
+
 ## 0.6.0
 
 - Improved unread notification emails. Team emails now summarize the unread

data/README.md

@@ -5,9 +5,13 @@
 [![CI](https://github.com/yshmarov/livechat/actions/workflows/ci.yml/badge.svg)](https://github.com/yshmarov/livechat/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue)](MIT-LICENSE)
 
-**Open-source live chat for Rails.** A chat bubble for your users, an inbox for
-your team — as a gem, not another service to deploy. Alternative to Crisp,
-Intercom and Chatwoot.
+**In-app support messaging for Rails.** Add a chat button so users can ask for
+help from the page where they got stuck. Your team answers from a mounted inbox.
+No SaaS account, no third-party script, no separate app, no customer data leaving
+your database.
+
+Use it when email is too detached, Intercom is too much, and Chatwoot is another
+app you do not want to deploy.
 
 ![The livechat widget open over a running Rails app](docs/screenshots/01-widget.png)
 
@@ -232,11 +236,35 @@ to a stream the server signed for it. Under a strict CSP, allow the socket with
 | `data-livechat-open` | Any element opens the panel on click |
 | `data-livechat-message="…"` | Prefill from that element — great for contextual buttons |
 | `<%= livechat_button %>` | A plain, unstyled opener button |
+| `<%= livechat_button("Ask about this order", message: "I need help with order ##{@order.id}") %>` | Open and prefill in one helper |
 | `config.show_launcher = false` | Hide the bubble entirely |
 
 While replies are unread, every `data-livechat-open` element carries a small
 count badge — so hiding the launcher never hides the answer.
 
+Contextual buttons are where a Rails app beats a generic support widget:
+
+```erb
+<%= livechat_button("Ask about this order",
+      message: "I need help with order ##{@order.id}") %>
+
+<%= livechat_button("Ask about this invoice",
+      message: "I need help with invoice ##{@invoice.number}") %>
+
+<button data-livechat-open
+        data-livechat-message="I need help with project <%= @project.name %>">
+  Contact support
+</button>
+```
+
+## Use cases
+
+- SaaS apps: answer billing, onboarding and account questions from inside the app.
+- Customer portals: let users ask about orders, invoices, documents or bookings.
+- Marketplaces: keep buyer, seller and admin support tied to the current page.
+- Internal tools: give non-technical teammates a direct line from admin screens.
+- Course and member apps: handle access, lesson and subscription questions in context.
+
 ## What it doesn't do
 
 No AI bots, no canned responses, no omnichannel (WhatsApp, Messenger…), no

data/app/helpers/livechat/widget_helper.rb

@@ -18,12 +18,17 @@ module Livechat
     end
 
     # A plain, unstyled <button> that opens the chat — it picks up the host's
-    # own styles. Put it anywhere on a page that also renders livechat_tag.
-    def livechat_button(label: nil, **)
+    # own styles. Pass message: to prefill the composer with page-specific
+    # context. Put it anywhere on a page that also renders livechat_tag.
+    def livechat_button(label = nil, message: nil, **options)
       return unless Livechat.enabled?(request)
 
+      label ||= options.delete(:label)
       label ||= I18n.t(:launcher, scope: :livechat, default: 'Chat with us')
-      tag.button(label, type: 'button', 'data-livechat-open': '', **)
+      data = (options.delete(:data) { {} } || {}).merge(livechat_open: '')
+      data[:livechat_message] = message if message.present?
+
+      tag.button(label, type: 'button', data: data, **options)
     end
 
     private

data/lib/livechat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Livechat
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livechat
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Yaroslav Shmarov