Skip to content

Commit a5fad08

Browse files
README updates
1 parent 6c207e2 commit a5fad08

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

README.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RabbitMQ HTTP API Client for Ruby
22

3-
This gem is a [RabbitMQ HTTP API](http://hg.rabbitmq.com/rabbitmq-management/raw-file/450b7ea22cfd/priv/www/api/index.html) client for Ruby. It supports
3+
This gem is a [RabbitMQ HTTP API]() client for Ruby. It supports
44

55
* Getting cluster overview information
66
* Getting cluster nodes status (# file descriptors used, RAM consumption and so on)
@@ -18,30 +18,44 @@ and will support more HTTP API features in the future
1818

1919
## Supported Ruby Versions
2020

21-
* CRuby 2.5 through 3.x
21+
* CRuby 2.7 through 3.x
2222
* JRuby 9K
2323

2424
## Supported RabbitMQ Versions
2525

26-
All [supported RabbitMQ release series](https://www.rabbitmq.com/versions.html).
26+
This library targets [RabbitMQ release series covered by community support](https://www.rabbitmq.com/release-information).
2727

28-
All versions require [RabbitMQ Management UI plugin](http://www.rabbitmq.com/management.html) to be installed and enabled.
28+
All versions require [RabbitMQ Management UI plugin](https://www.rabbitmq.com/docs/management/) to be installed and enabled.
2929

3030
## Installation
3131

32-
Add this line to your application's Gemfile:
32+
Add this line to your application's Gemfile to
33+
use the latest version of this library:
3334

3435
``` ruby
36+
# Depends on Faraday 2.x
37+
gem 'rabbitmq_http_api_client', '>= 3.0.0'
38+
```
39+
40+
If you **absolutely must** use Faraday 1.x, use the 2.x series:
41+
42+
``` ruby
43+
# Depends on Faraday 1.x.
44+
# Consider using 3.0.0 and later versions.
3545
gem 'rabbitmq_http_api_client', '>= 2.2.0'
3646
```
3747

3848
And then execute:
3949

40-
bundle install
50+
``` shell
51+
bundle install
52+
```
4153

42-
Or install it yourself as:
54+
Or install it manually with:
4355

44-
gem install rabbitmq_http_api_client
56+
``` shell
57+
gem install rabbitmq_http_api_client
58+
```
4559

4660
## Usage
4761

@@ -349,8 +363,8 @@ ps = client.clear_permissions_of("/", "guest")
349363
Before running the test suites, run a script that will set up the local node:
350364

351365
``` shell
352-
export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQCTL="rabbitmqctl"
353-
export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQ_PLUGINS="rabbitmq-plugins"
366+
export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQCTL="/path/to/sbin/rabbitmqctl"
367+
export RUBY_RABBITMQ_HTTP_API_CLIENT_RABBITMQ_PLUGINS="/path/to/sbin/rabbitmq-plugins"
354368

355369
./bin/ci/before_build.sh
356370
```
@@ -365,10 +379,6 @@ bundle exec rspec -cfd spec
365379
The test suite assumes that RabbitMQ is running locally with stock settings
366380
and rabbitmq-management plugin enabled.
367381

368-
## Continuous Integration
369-
370-
[![Build Status](https://travis-ci.org/ruby-amqp/rabbitmq_http_api_client.svg?branch=master)](https://travis-ci.org/ruby-amqp/rabbitmq_http_api_client)
371-
372382

373383
## Contributing
374384

@@ -381,6 +391,6 @@ and rabbitmq-management plugin enabled.
381391

382392
## License & Copyright
383393

384-
Double-licensed under the MIT and Mozilla Public License (same as RabbitMQ).
394+
Double-licensed under the MIT and the Mozilla Public License 2.0 ([same as RabbitMQ](https://github.com/rabbitmq/rabbitmq-server/blob/main/LICENSE)).
385395

386-
(c) Michael S. Klishin, 2012-2020.
396+
(c) Michael S. Klishin, 2012-2024.

0 commit comments

Comments
 (0)