Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
(cherry picked from commit f433059)
  • Loading branch information
michaelklishin committed Oct 19, 2024
1 parent dabac9c commit 288f19b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
3 changes: 2 additions & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Copyright (c) 2013-2016 Dotan Nahum
Copyright (c) 2013-2023 Dotan Nahum
Copyright (c) 2023-2024 Kicks Contributors

MIT License

Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,19 @@ By virtue of its Sneakers lineage, Kicks is a mature project that has been aroun
Add this line to your application's Gemfile:

```ruby
# Important: this name will change once Kicks 3.0.0 (the initial release) is published
gem 'sneakers'
gem 'kicks'
```

And then execute:

```shell-session
$ bundle
bundle
```

Or install it yourself as:

```shell-session
$ gem install sneakers
gem install kicks
```

## Documentation
Expand All @@ -57,7 +56,7 @@ Set up a Gemfile

```ruby
source 'https://rubygems.org'
gem 'sneakers'
gem 'kicks'
gem 'json'
gem 'redis'
```
Expand All @@ -68,6 +67,7 @@ then create a worker named as `Processor`.
> touch boot.rb
```ruby
# Note: the files still use "sneakers" for the name
require 'sneakers'
require 'redis'
require 'json'
Expand Down Expand Up @@ -191,7 +191,9 @@ environment needed locally on your development box.

# Compatibility

* Sneakers main branch: Ruby 3.0+
* Kicks main branch: Ruby 3.0+
* Kicks 3.1.x branch: Ruby 3.0+
* Kicks 3.0.x: Ruby 2.5+
* Sneakers 2.7.x and later (using Bunny 2.9): Ruby 2.2.x
* Sneakers 1.1.x and later (using Bunny 2.x): Ruby 2.x
* Sneakers 1.x.x and earlier: Ruby 1.9.x, 2.x
Expand Down

0 comments on commit 288f19b

Please sign in to comment.