redmineflux_icon_compat 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e13f0604cfb7cd9b8a19058158bd81fb61bba6ca32fc84e0044b9481dae0faaf
-  data.tar.gz: 61704c9b1b47ea9030ed3752638b2de9f7e16dc219d962c5d1849971108dedfe
+  metadata.gz: 6086040e39bd5cf0e82f22f90afdc29853117f6ec8fffbc3ae76cfc5ab1a8b57
+  data.tar.gz: 207d95b7aece44166ec87a713bac13fbca6aef984ad9c9f0e576d6f96c2184c5
 SHA512:
-  metadata.gz: dc75480b32b6ff1a82a2f0a128ac23f6277b43f875e99aca71fe36c0c254c83db4eb422ab74755c1b45a98ba197f9fde9f933506126688f0224ec2d5d22fdc05
-  data.tar.gz: d542b29d7b96acbb9b80c7df35e70aaa3b1b1571724d5bf88f16c931ece299047bf7984427e6fdad76abe173011c3a29fd0fd6ef19a9c756edc62fdfb54e2671
+  metadata.gz: 1cda2877c0643b538626171e024e3046e68b6f74cc3fa314cc5b0e3988fb81e810a53e5ad6e7c54bb448f849e99e03539f3d2dba657d4660fb049e1ed506d9a8
+  data.tar.gz: 8c4995d5b73663acd7919ebd3fe02bf1f1b113a6a0d2bd342f1eb916bb97204a47a5572495228f5baad72b0fa9e7c8a71ae9ce00f0661ecb6bfd2cb2e17562cc

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `redmineflux_icon_compat` will be documented in this file.
 
+## [0.1.2] - 2026-04-17
+
+### Changed
+- Updated README wording and usage clarity.
+- Updated RubyGems dependency example to `~> 0.1.2`.
+
 ## [0.1.1] - 2026-04-16
 
 ### Added

data/README.md

@@ -1,27 +1,27 @@
 # Redmineflux Icon Compat
 
-Compatibility helper gem for Redmine plugin icons.
+`redmineflux_icon_compat` provides one helper API for plugin links that works in both:
+- Redmine 5 legacy icon classes (`icon icon-*`)
+- Redmine 6 sprite icons (`sprite_icon`)
 
-This gem gives one helper API (`rf_icon_link`) that works in both:
-- Redmine 5 style icons (`icon icon-*` classes)
-- Redmine 6 SVG sprite icons (`sprite_icon`)
+Use `rf_icon_link` to keep one code path across Redmine versions.
 
-## Use This Gem In A Redmine Plugin
+## Install In A Redmine Plugin
 
-### 1) Add gem declaration in your plugin Gemfile
+### 1) Add the gem to your plugin Gemfile
 
 Create or update `plugins/<your_plugin>/Gemfile`.
 
-For local development:
+Local development:
 
 ```ruby
 gem 'redmineflux_icon_compat', path: '../redmineflux_icon_compat'
 ```
 
-For published usage from RubyGems:
+From RubyGems:
 
 ```ruby
-gem 'redmineflux_icon_compat', '~> 0.1.0'
+gem 'redmineflux_icon_compat', '~> 0.1.2'
 ```
 
 ### 2) Install dependencies
@@ -32,7 +32,7 @@ From Redmine root:
 bundle install
 ```
 
-### 3) Load gem in plugin init file
+### 3) Require the gem in plugin init
 
 In `plugins/<your_plugin>/init.rb`:
 
@@ -40,9 +40,7 @@ In `plugins/<your_plugin>/init.rb`:
 require 'redmineflux_icon_compat'
 ```
 
-### 4) Include helper in plugin helpers (optional but recommended)
-
-Example:
+### 4) Include the helper (recommended)
 
 ```ruby
 module MyPluginHelper
@@ -50,29 +48,29 @@ module MyPluginHelper
 end
 ```
 
-### 5) Use `rf_icon_link` in views or helpers
+### 5) Use `rf_icon_link` in views/helpers
 
-Example in ERB:
+ERB example:
 
 ```erb
 <%= rf_icon_link(:add, 'Add Checklist', '#', class: 'add-checklist-btn') %>
 ```
 
-Example in helper:
+Helper example:
 
 ```ruby
 rf_icon_link(:edit, l(:button_edit), edit_path(record))
 ```
 
-### 6) Restart Redmine server
+### 6) Restart Redmine
 
-After gem or helper changes, restart app server so Rails reloads plugin code.
+Restart the app server after gem/helper changes so code reload is clean.
 
 ## Troubleshooting
 
 If you still see old icons:
-- run `rm -rf tmp/cache/*`
-- run `bundle install` again
+- clear cache: `rm -rf tmp/cache/*`
+- reinstall dependencies: `bundle install`
 - restart Redmine
 - hard refresh browser (`Ctrl+Shift+R`)
 
@@ -84,59 +82,8 @@ From Redmine root:
 ruby plugins/redmineflux_icon_compat/test/helper_test.rb
 ```
 
-Or from gem directory:
+From this gem directory:
 
 ```bash
-cd plugins/redmineflux_icon_compat
 ruby test/helper_test.rb
 ```
-
-## Publish To RubyGems
-
-1. Create RubyGems account: https://rubygems.org/sign_up
-2. Login from terminal:
-
-```bash
-gem signin
-```
-
-3. Bump version in:
-- `plugins/redmineflux_icon_compat/lib/redmineflux_icon_compat/version.rb`
-
-4. Run tests:
-
-```bash
-ruby plugins/redmineflux_icon_compat/test/helper_test.rb
-```
-
-5. Build the gem:
-
-```bash
-cd plugins/redmineflux_icon_compat
-gem build redmineflux_icon_compat.gemspec
-```
-
-6. Push to RubyGems:
-
-```bash
-gem push redmineflux_icon_compat-<VERSION>.gem
-```
-
-7. Verify publication:
-- Open `https://rubygems.org/gems/redmineflux_icon_compat`
-- Check docs page after indexing: `https://www.rubydoc.info/gems/redmineflux_icon_compat`
-- Install smoke test:
-
-```bash
-gem install redmineflux_icon_compat
-```
-
-## Ownership and Security (Recommended)
-
-Add backup owners:
-
-```bash
-gem owner redmineflux_icon_compat --add teammate@example.com
-```
-
-Require MFA on RubyGems account for push/yank.

data/lib/redmineflux_icon_compat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedminefluxIconCompat
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmineflux_icon_compat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Redmineflux
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-16 00:00:00.000000000 Z
+date: 2026-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview