Skip to content

Commit 8fa5a13

Browse files
agrbergclaude
andcommitted
Fix README typo and add CI badge and Ruby version
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent fedc7b9 commit 8fa5a13

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Cacheable
22

3+
[![CI](https://github.com/splitwise/cacheable/actions/workflows/ci.yml/badge.svg)](https://github.com/splitwise/cacheable/actions/workflows/ci.yml)
4+
35
By [Splitwise](https://www.splitwise.com)
46

7+
Requires Ruby >= 3.3
8+
59
Cacheable is a gem which adds method caching in Ruby following an [aspect-oriented programming (AOP)](https://en.wikipedia.org/wiki/Aspect-oriented_programming) paradigm. Its core goals are:
610

711
* ease of use (method annotation)
@@ -131,7 +135,7 @@ Fetching data from GitHub
131135

132136
#### Default
133137

134-
By default, Cacheable will construct key a key in the format `[cache_key || class_name, method_name]` without using method arguments.
138+
By default, Cacheable will construct a key in the format `[cache_key || class_name, method_name]` without using method arguments.
135139

136140
If the object responds to `cache_key` its return value will be the first element in the array. `ActiveRecord` provides [`cache_key`](https://api.rubyonrails.org/classes/ActiveRecord/Integration.html#method-i-cache_key) but it can be added to any Ruby object or overwritten. If the object does not respond to it, the name of the class will be used instead. The second element will be the name of the method as a symbol.
137141

0 commit comments

Comments
 (0)