Skip to content

Commit 75d5a8e

Browse files
committed
chore: Update README.md
1 parent dbc4ab7 commit 75d5a8e

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ See [Docker](#docker) and [Samples](#samples) sections to get started!
2222

2323
Join our [Discord server!](https://discord.gg/ahK7Vjr8We)
2424

25-
The current production version is [v0.4.9](https://github.com/buraksezer/olric/tree/release/v0.4.0#olric-)
25+
The current production version is [v0.5.0](https://github.com/buraksezer/olric/tree/release/v0.5.0#olric-)
2626

2727
### About versions
2828

@@ -31,8 +31,6 @@ Olric v0.4.x tree is going to receive bug fixes and security updates forever, bu
3131

3232
This document only covers `v0.5`. See v0.4.x documents [here](https://github.com/buraksezer/olric/tree/release/v0.4.0#olric-).
3333

34-
**Important note**: Documenting `v0.5` is an ongoing effort. So some parts of this document may be wrong or inaccurate.
35-
3634
## At a glance
3735

3836
* Designed to share some transient, approximate, fast-changing data between servers,
@@ -70,7 +68,8 @@ It's good at distributed caching and publish/subscribe messaging.
7068
* [Operation Modes](#operation-modes)
7169
* [Embedded Member](#embedded-member)
7270
* [Client-Server](#client-server)
73-
* [Golang client](#golang-client)
71+
* [Golang Client](#golang-client)
72+
* [Cluster Events](#cluster-events)
7473
* [Commands](#commands)
7574
* [Distributed Map](#distributed-map)
7675
* [DM.PUT](#dmput)
@@ -284,6 +283,20 @@ a better performance due to localization of the queries.
284283

285284
See the client documentation on [pkg.go.dev](https://pkg.go.dev/github.com/buraksezer/olric@v0.5.0-rc.1)
286285

286+
## Cluster Events
287+
288+
Olric can send push cluster events to `cluster.events` channel. Available cluster events:
289+
290+
* node-join-event
291+
* node-left-event
292+
* fragment-migration-event
293+
* fragment-received-even
294+
295+
If you want to receive these events, set `true` to `EnableClusterEventsChannel` and subscribe to `cluster.events` channel.
296+
The default is `false`.
297+
298+
See [events/cluster_events.go](events/cluster_events.go) file to get more information about events.
299+
287300
## Commands
288301

289302
Olric uses Redis protocol and supports Redis-style commands to query the database. You can use any Redis client, including
@@ -982,12 +995,6 @@ timeout and 0 for default. The default is config.DefaultReadTimeout
982995

983996
Timeout for socket writes. If reached, commands will fail with a timeout instead of blocking. The default is config.DefaultWriteTimeout
984997

985-
##### config.KeepAlive
986-
987-
KeepAlive specifies the interval between keep-alive probes for an active network connection. If zero, keep-alive probes
988-
are sent with a default value (currently 15 seconds), if supported by the protocol and operating system. Network protocols
989-
or operating systems that do not support keep-alives ignore this field. If negative, keep-alive probes are disabled.
990-
991998
## Architecture
992999

9931000
### Overview

olric.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ import (
5757
)
5858

5959
// ReleaseVersion is the current stable version of Olric
60-
const ReleaseVersion string = "0.5.0-rc.1"
60+
const ReleaseVersion string = "0.5.0"
6161

6262
var (
6363
// ErrOperationTimeout is returned when an operation times out.

0 commit comments

Comments
 (0)