Skip to content

Commit 9bcc2bc

Browse files
authored
Update README.md (#12)
<!-- Please use this template for your pull request. --> <!-- Please use the sections that you need and delete other sections --> ## This PR - Add gem version badge - Add build status to README - Remove stray `await` from documentation Signed-off-by: Jose Miguel Colella <[email protected]> ### Related Issues references #7
2 parents 3f6c9b6 + d64ea30 commit 9bcc2bc

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# OpenFeature SDK for Ruby
1+
# OpenFeature SDK for Ruby
22

33
[![a](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1)
44
[![v0.5.1](https://img.shields.io/static/v1?label=Specification&message=v0.5.1&color=yellow)](https://github.com/open-feature/spec/tree/v0.5.1)
55
![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white)
6+
![Build](https://github.com/open-feature/openfeature-ruby/actions/workflows/main.yml/badge.svg?branch=main)
7+
![Gem version](https://img.shields.io/gem/v/openfeature-sdk)
68

79
This is the Ruby implementation of [OpenFeature](https://openfeature.dev), a vendor-agnostic abstraction library for evaluating feature flags.
810

@@ -44,18 +46,18 @@ end
4446
# Create a client
4547
client = OpenFeature::SDK.build_client(name: "my-app")
4648

47-
# get a bool value
48-
const bool_value = client.fetch_boolean_value(flag_key: 'boolean_flag', default_value: false);
49+
# fetching boolean value feature flag
50+
bool_value = client.fetch_boolean_value(flag_key: 'boolean_flag', default_value: false);
4951

50-
// get a string value
51-
const string_value = client.fetch_string_value(flag_key: 'string_flag', default_value: false);
52+
# fetching string value feature flag
53+
string_value = client.fetch_string_value(flag_key: 'string_flag', default_value: false);
5254

53-
// get an numeric value
54-
const float_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1.0);
55-
const integer_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1);
55+
# fetching number value feature flag
56+
float_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1.0);
57+
integer_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1);
5658

57-
// get an object value
58-
const object = await client.fetch_object_value('object_value', JSON.dump({ name: 'object'}));
59+
# get an object value
60+
object = client.fetch_object_value('object_value', JSON.dump({ name: 'object'}));
5961
```
6062

6163
For complete documentation, visit: https://docs.openfeature.dev/docs/category/concepts

0 commit comments

Comments
 (0)