source_monitor 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3831f3ec3fa841e1e15fb16fc7ab780177d35353fce96975338c2e7aa129bd9f
-  data.tar.gz: ac970a0b226c1b8c1c9a266a892754941d92173b8753ac37d2a4cd89f1895fd9
+  metadata.gz: e458adf0859216249883d76b07cc0610f9f47f41f482ac1d480be3bc06ec26f1
+  data.tar.gz: 8db6aa2f83ee694c0425b411d55454508618a3bfd06859cd1809bd2eeb6e0ee6
 SHA512:
-  metadata.gz: 46dc5a034c7b7c294877d124a59b632aec2cfbc420544835b06d0809a7e8d574930ffc86cd5bfbceb436516a0bc88b55ffdb34a38a0bb873ae3892bb3615b503
-  data.tar.gz: 542c9c82713daadb6f0cfa4151ab99df55440a8e86a553ee46b2223806096f6d36d1e1987890f50aaad83132498c674793cae11c11752a897daca6c36efb1a94
+  metadata.gz: 02f03ed5c8bb35fd658d85fa61fc3b57c3b1cdea5e75a3bfaeb21305f5691dd1ceed8178fe56e1d3547d4d0da79840952d9c66b6770a722bf907f7e55444bd1a
+  data.tar.gz: d832c80021645849113163fe3ac91b606a6852572285dd473452a544da6f68718ec2ce61eb605b6b3206ad1343caac8606d9229cd930d434bd5bcdb8124fdb84

data/CHANGELOG.md

@@ -15,6 +15,16 @@ All notable changes to this project are documented below. The format follows [Ke
 
 - No unreleased changes yet.
 
+## [0.1.3] - 2025-11-13
+
+### Added
+
+- Clarified installation instructions for consumers: add `gem "source_monitor"` via RubyGems before running the guided workflow (README + docs/setup.md).
+
+### Testing
+
+- Documentation-only update; no code changes.
+
 ## [0.1.2] - 2025-11-13
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    source_monitor (0.1.2)
+    source_monitor (0.1.3)
       cssbundling-rails (~> 1.4)
       faraday (~> 2.9)
       faraday-follow_redirects (~> 0.4)

data/README.md

@@ -2,6 +2,20 @@
 
 SourceMonitor is a production-ready Rails 8 mountable engine for ingesting, normalising, scraping, and monitoring RSS/Atom/JSON feeds. It ships with a Tailwind-powered admin UI, Solid Queue job orchestration, Solid Cable realtime broadcasting, and an extensible configuration layer so host applications can offer full-stack feed operations without rebuilding infrastructure.
 
+> **Note:** Application developers consume SourceMonitor via RubyGems—add the gem to your host application's Gemfile and follow the guided installer. Clone this repository only when contributing to the engine itself.
+
+## Installation (RubyGems)
+
+In your host Rails app:
+
+```bash
+bundle add source_monitor --version "~> 0.1.2"
+# or add `gem "source_monitor", "~> 0.1.2"` manually, then run:
+bundle install
+```
+
+This exposes `bin/source_monitor` (via Bundler binstubs) so you can run the guided workflow described below.
+
 ## Highlights
 - Full-featured source and item administration backed by Turbo Streams and Tailwind UI components
 - Adaptive fetch pipeline (Feedjira + Faraday) with conditional GETs, retention pruning, and scrape orchestration
@@ -22,6 +36,16 @@ SourceMonitor is a production-ready Rails 8 mountable engine for ingesting, norm
 
 > **Command prefixes:** Examples below show bare `bundle`, `bin/rails`, and `bin/source_monitor`. If you use rbenv/asdf or containerized tooling, prefix/adjust commands accordingly so they run inside your Ruby environment.
 
+### Install the Gem
+
+Before running any SourceMonitor commands inside your host app, add the gem and install dependencies:
+
+```bash
+bundle add source_monitor --version "~> 0.1.2"
+# or edit your Gemfile, then run
+bundle install
+```
+
 ### Recommended: Guided Workflow
 1. **Optional prerequisite check:** `bin/rails source_monitor:setup:check`
 2. **Run the guided installer:** `bin/source_monitor install --yes`
@@ -30,7 +54,7 @@ SourceMonitor is a production-ready Rails 8 mountable engine for ingesting, norm
 4. **Verify anytime:** `bin/source_monitor verify` (also exposed as `bin/rails source_monitor:setup:verify`). The command prints a human summary plus JSON so CI can gate on Solid Queue and Action Cable health.
 5. **Visit the dashboard** at the chosen mount path and trigger “Fetch Now” on a source to confirm everything is wired.
 
-See [docs/setup.md](docs/setup.md) for the full workflow (prereq table, rollback steps, telemetry flag, Devise system test template).
+See [docs/setup.md](docs/setup.md) for the full workflow (prereq table, gem installation, rollback steps, telemetry flag, Devise system test template).
 
 ### Manual Install (Advanced)
 Prefer explicit Rails generator steps or need to customize each phase? The same document covers a full **Manual Installation** section so you can copy/paste each command into bespoke pipelines.

data/docs/setup.md

@@ -1,6 +1,6 @@
 # SourceMonitor Setup Workflow
 
-This guide consolidates the new guided installer, verification commands, and rollback steps so teams can onboard the engine into either a fresh Rails host or an existing application without missing prerequisites.
+This guide consolidates the new guided installer, verification commands, and rollback steps so teams can onboard the engine into either a fresh Rails host or an existing application without missing prerequisites. You never need to clone the SourceMonitor repository for installation—simply add the gem to your host application's Gemfile and run the steps below.
 
 ## Prerequisites
 
@@ -13,6 +13,18 @@ This guide consolidates the new guided installer, verification commands, and rol
 | Background jobs | Solid Queue (>= 0.3, < 3.0) | Add `solid_queue` to the host Gemfile if not present. |
 | Realtime | Solid Cable (>= 3.0) or Redis | Solid Cable is the default; Redis requires `config.realtime.adapter = :redis`. |
 
+## Install the Gem
+
+Run these commands inside your host Rails application before invoking the guided workflow:
+
+```bash
+bundle add source_monitor --version "~> 0.1.2"
+# or add gem "source_monitor", "~> 0.1.2" to Gemfile manually
+bundle install
+```
+
+This ensures Bundler can load SourceMonitor so the commands below are available.
+
 ## Guided Setup (Recommended)
 
 1. **Check prerequisites** (optional but fast):

data/lib/source_monitor/version.rb

@@ -1,3 +1,3 @@
 module SourceMonitor
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: source_monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - dchuk