Skip to content

Commit 6e43186

Browse files
authored
Modernize README to follow Ruby open source best practices (#77)
* docs: modernize README to follow Ruby open source best practices - Add badges for gem version, CI status, and license - Add table of contents for easier navigation - Add Ruby compatibility matrix (3.1-3.4) - Improve installation with Bundler instructions - Use collapsible sections for GSL install and benchmarks - Add syntax highlighting to all code blocks - Add Development section with setup and test instructions - Add Contributing guidelines - Improve examples (spam filter, persistence, LSI search) - Reorganize structure with Quick Start sections Closes #76 * chore: update minitest to 6.0.1 for Ruby 4.0 support * chore: drop Ruby 3.1 support (EOL March 2025) * chore: add ostruct gem and update rake for Ruby 4.0
1 parent ba36830 commit 6e43186

4 files changed

Lines changed: 215 additions & 109 deletions

File tree

.github/workflows/ruby.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
runs-on: ubuntu-latest
3434
strategy:
3535
matrix:
36-
ruby-version: ['3.1', '3.2', '3.3', '3.4']
36+
ruby-version: ['3.2', '3.3', '3.4', '4.0']
3737

3838
steps:
3939
- uses: actions/checkout@v4

Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ gemspec
44
gem 'fast-stemmer'
55
gem 'matrix'
66
gem 'mutex_m'
7+
gem 'ostruct'
78

89
group :test do
910
gem 'simplecov', require: false

Gemfile.lock

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ GEM
1717
language_server-protocol (3.17.0.5)
1818
lint_roller (1.1.0)
1919
matrix (0.4.2)
20-
minitest (5.18.1)
20+
minitest (6.0.1)
21+
prism (~> 1.5)
2122
mutex_m (0.2.0)
23+
ostruct (0.6.3)
2224
parallel (1.27.0)
2325
parser (3.3.10.0)
2426
ast (~> 2.4.1)
@@ -28,7 +30,7 @@ GEM
2830
stringio
2931
racc (1.8.1)
3032
rainbow (3.1.1)
31-
rake (13.0.6)
33+
rake (13.3.1)
3234
rdoc (6.5.1.1)
3335
psych (>= 4.0.0)
3436
regexp_parser (2.11.3)
@@ -74,6 +76,7 @@ DEPENDENCIES
7476
matrix
7577
minitest
7678
mutex_m
79+
ostruct
7780
rdoc
7881
rubocop
7982
rubocop-minitest

0 commit comments

Comments
 (0)