docs: update README documentation for initial release

[NeaguGeorgiana23]

This PR

Updates the README.md to accurately reflect the current state of the OpenFeature C++ SDK and provides concrete usage examples for developers.

• Updates the features table.
• Adds C++ code snippets for SDK initialization, registering the InMemoryProvider, and basic flag evaluation.
• Adds C++ code snippets demonstrating synchronous and asynchronous provider registration.
• Adds C++ code snippets demonstrating Evaluation Context targeting at the global, client, and invocation levels.
• Adds C++ code snippets for Domain-scoped clients and API shutdown.

Related Issues

Fixes #71

[gemini-code-assist]

Summary of Changes

Hello @NeaguGeorgiana23, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the OpenFeature C++ SDK's README.md documentation. The primary goal is to provide developers with up-to-date information and practical C++ code examples for key functionalities, making it easier to understand and integrate the SDK. The changes cover core aspects like setup, provider management, flag evaluation with targeting, and extending the SDK, ensuring the documentation aligns with the current capabilities of the library.

Highlights

• Documentation Update: The README.md has been significantly updated to accurately reflect the current state of the OpenFeature C++ SDK.
• Requirements and Installation: The requirements section now specifies C++17 or newer and Bazel, along with instructions for adding the SDK dependency in Bazel projects.
• Usage Examples: New C++ code snippets have been added for basic SDK initialization, registering the InMemoryProvider, and evaluating a boolean flag.
• Provider Registration: Examples for both synchronous (SetProviderAndWait) and asynchronous (SetProvider) provider registration have been included.
• Evaluation Context Targeting: Detailed C++ code snippets demonstrate how to set evaluation contexts at global, client, and invocation levels for targeting.
• Domain-scoped Clients: Examples show how to register providers to specific domains and retrieve domain-scoped clients.
• API Shutdown: A code snippet illustrates how to gracefully shut down all registered providers using OpenFeatureAPI::Shutdown().
• Extending the SDK: A comprehensive C++ code example outlines the implementation of a custom FeatureProvider.
• Features Table: The features table has been updated to reflect the current implementation status of various SDK features, marking 'Targeting', 'Domains', 'Shutdown', and 'Extending' as implemented.

Changelog

• README.md
  • Updated the 'Requirements' section to specify C++17 and Bazel.
  • Added instructions for installing the SDK in Bazel projects.
  • Included a basic C++ usage example demonstrating SDK initialization, InMemoryProvider setup, and boolean flag evaluation.
  • Revised the features table to accurately reflect the implementation status of 'Targeting', 'Domains', 'Shutdown', and 'Extending'.
  • Added C++ code snippets for synchronous and asynchronous provider registration.
  • Provided C++ code examples for setting global, client-level, and invocation-level evaluation contexts.
  • Introduced C++ code snippets for registering domain-specific providers and obtaining domain-scoped clients.
  • Added a C++ code example for performing a global API shutdown.
  • Included a detailed C++ code snippet demonstrating how to implement a custom FeatureProvider.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the README.md by replacing TODO comments with concrete and comprehensive usage examples for the OpenFeature C++ SDK. The updates cover essential aspects such as SDK initialization, provider registration (synchronous and asynchronous), evaluation context targeting at various levels, domain-scoped clients, API shutdown, and a basic provider implementation. Additionally, the features table has been updated to accurately reflect the current status of implemented features. These changes greatly enhance the documentation and provide clear guidance for developers using the SDK.