From d45bad41a71e58461eda5d089868198767f6999f Mon Sep 17 00:00:00 2001 From: Jan <59206115+Threated@users.noreply.github.com> Date: Fri, 26 Jul 2024 17:15:57 +0200 Subject: [PATCH] Update Readme and Changelog Co-authored-by: Martin Lablans <6804500+lablans@users.noreply.github.com> --- CHANGELOG.md | 1 + README.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f644a767..ab1737e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ This major release of Beam 0.8 features many changes "under the hood", such as t * New functions in beam lib to create sockets with metadata. * Added `beam_lib::RawString`, a string wrapper to prevent beam lib from json encoding the string again. This is useful for beam_lib clients that handle serializing and deserializing types outside of beam_lib. * Added a dedicated `beam_lib::Error::InvalidReceivers` error variant holding all invalid receivers when trying to create a task with invalid recipients. +* Use new Samply CI/CD workflow for Github Actions. ## Bugfixes diff --git a/README.md b/README.md index 2b50cc10..28fe1576 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Samply.Beam is a distributed task broker designed for efficient communication ac ## Latest version: Samply.Beam 0.8.0 – 2024-07-26 -This new major version includes some bugfixes, dependency upgrades and improvements to `beam-lib`. Please check the [Changelog](CHANGELOG.md) for more details. +This new major version includes some bugfixes, dependency upgrades and improvements to `beam-lib`. Please check the [Changelog](CHANGELOG.md) for details. Find info on all previous versions in the [Changelog](CHANGELOG.md). @@ -524,7 +524,7 @@ Initialize a socket connection with an Beam application, e.g. with AppId `app2.p Method: `POST` URL: `/v1/sockets/` Header `Upgrade` is required, e.g. 'Upgrade: tls' -Optionally takes a `metadata` header which is expected to be serialized json value. +Optionally takes a `metadata` header which is expected to be a serialized json value. This corresponds to the `metadata` field on [Socket task](#socket-task). This request will automatically lead to a connection to the other app, after it answers this request.