Commit 6e43186
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.01 parent ba36830 commit 6e43186
4 files changed
Lines changed: 215 additions & 109 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | | - | |
| 36 | + | |
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
| 20 | + | |
| 21 | + | |
21 | 22 | | |
| 23 | + | |
22 | 24 | | |
23 | 25 | | |
24 | 26 | | |
| |||
28 | 30 | | |
29 | 31 | | |
30 | 32 | | |
31 | | - | |
| 33 | + | |
32 | 34 | | |
33 | 35 | | |
34 | 36 | | |
| |||
74 | 76 | | |
75 | 77 | | |
76 | 78 | | |
| 79 | + | |
77 | 80 | | |
78 | 81 | | |
79 | 82 | | |
| |||
0 commit comments