From 35903bbf433baef61711252b864bd04602895169 Mon Sep 17 00:00:00 2001 From: Mohamad Fadhil Date: Thu, 12 Dec 2024 19:37:00 +0800 Subject: [PATCH] Update README.md (#36) Signed-off-by: Mohamad Fadhil --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 474dc1c..8d975ce 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ one can set the [`syncInterval`](./cluster/config.go) value to a low value. The - `Put`: create key/value pair that is eventually distributed in the cluster of nodes. The `key` is a string and the `value` is a byte array. One can set an expiry to the key. - `PutProto`: to create a key/value pair where the value is a protocol buffer message - `PutString`: to create a key/value pair where the value is a string - - `PutAny`: to create a key/value pair with a given [`Codec`](./cluster/codec.go) to encode the value type. + - `PutAny`: to create a key/value pair with a given [`Codec`](./codec.go) to encode the value type. - `Get`: retrieves the value of a given `key` from the cluster of nodes. This can return a false negative meaning that the key may exist but at the time of checking it is having yet to be replicated in the cluster. - `GetProto`: retrieves a protocol buffer message for a given `key`. This requires `PutProto` or `Put` to be used to set the value. - `GetString`: retrieves a string value for a given `key`. This requires `PutString` or `Put` to be used to set the value. @@ -88,4 +88,4 @@ To get the [kubernetes](https://kubernetes.io/docs/home/) discovery working as e - `PortName`: the client port name. This port is used by the built-in cluster client for the various operations on the key/value pair distributed store - `PodLabels`: the POD labels -Make sure to provide the right RBAC settings to be able to access the pods. \ No newline at end of file +Make sure to provide the right RBAC settings to be able to access the pods.