From 5ec704709433a22488f43c4da90aea5bf10d8362 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Tue, 11 Jun 2024 19:09:10 +0530 Subject: [PATCH 1/4] Updated readme, updated warning for usage of API_KEY --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bb961c707..cc7287c2f 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,8 @@ client = Ably::Realtime.new(key: 'xxxxx') client = Ably::Realtime.new(token: 'xxxxx') ``` +`Warning - Do not expose ABLY_KEY to client code. It is meant to only be used at server side`. + If you do not have an API key, [sign up for a free API key now](https://ably.com/signup) ### Connection From 0fd62294e9b39a15d7fbdb6bd3302615e2a40034 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Wed, 12 Jun 2024 12:15:21 +0530 Subject: [PATCH 2/4] updated README, added comment for creating API_KEY --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cc7287c2f..8a118e34c 100644 --- a/README.md +++ b/README.md @@ -61,10 +61,10 @@ All examples assume a client has been created using one of the following: ```ruby # basic auth with an API key -client = Ably::Realtime.new(key: 'xxxxx') +client = Ably::Realtime.new(key: 'API_KEY_COPIED_FROM_ABLY_WEB_DASHBOARD') # using token auth -client = Ably::Realtime.new(token: 'xxxxx') +client = Ably::Realtime.new(token: 'TOKEN_CREATED_USING_ABLY_KEY') ``` `Warning - Do not expose ABLY_KEY to client code. It is meant to only be used at server side`. From b2c5774a74dde634c6af24a7ab2265c4f97e06d2 Mon Sep 17 00:00:00 2001 From: sachin shinde Date: Fri, 5 Jul 2024 10:09:10 +0000 Subject: [PATCH 3/4] dummu commit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a118e34c..ffe5b987b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ _[Ably](https://ably.com) is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale. For more information, see the [Ably documentation](https://ably.com/documentation)._ -This is a Ruby client library for Ably. The library currently targets the [Ably 1.2 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix). +This is a Ruby client library for Ably. The library currently targets the [Ably 2.0.2 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix). ## Supported platforms From 11fc428f16d2c93ba5c419fea0e9c9dc10d42b6c Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Wed, 17 Jul 2024 10:55:23 +0530 Subject: [PATCH 4/4] Updated README to support ruby 2.7 onwards --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ffe5b987b..8fe05c2cd 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ This is a Ruby client library for Ably. The library currently targets the [Ably ## Supported platforms -This SDK supports Ruby 2.7 and 3.x. For eventmachine and Ruby 3.x note please visit [Ruby 3.0 support](#ruby-30-support) section. +This SDK supports Ruby 2.7 onwards. For eventmachine and Ruby 3.x note please visit [Ruby 3.0 support](#ruby-30-support) section. As of v1.1.5 this library requires `libcurl` as a system dependency. On most systems this is already installed but in rare cases where it isn't (for example debian-slim Docker images such as ruby-slim) you will need to install it yourself. On debian you can install it with the command `sudo apt-get install libcurl4`.