From d396bd40ceebdb3a6c0a4a2cdf7ef8bf28e8dc0e Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Thu, 31 Oct 2024 14:52:15 -0400 Subject: [PATCH 1/3] docs: switch from code gen to cli Signed-off-by: Michael Beemer --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9e59ae9..4271da7 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

-

OpenFeature CodeGen

+

OpenFeature CLI

@@ -21,28 +21,37 @@ > [!CAUTION] -> OpenFeature CodeGen experimental! -> Feel free to give it a shot and provide feedback but expect breaking changes. +> The OpenFeature CLI is experimental! +> Feel free to give it a shot and provide feedback, but expect breaking changes. [OpenFeature](https://openfeature.dev) is an open specification that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool or in-house solution. -## Why CodeGen? +## Overview -CodeGen automates the creation of strongly typed flag accessors, minimizing configuration errors and provides a better developer experience. +The OpenFeature CLI is a command-line tool designed to improve the developer experience of feature flags. +The initial initial version of the CLI focuses on code generation. + +## Installation + +Download packaged binaries from the [releases page](https://github.com/open-feature/codegen/releases). + +### Why Code Generation? + +Code generation automates the creation of strongly typed flag accessors, minimizing configuration errors and providing a better developer experience. By generating these accessors, developers can avoid issues related to incorrect flag names or types, resulting in more reliable and maintainable code. -## Goals +### Goals - **Unified Flag Manifest Format**: Establish a standardized flag manifest format that can be easily converted from existing configurations. - **Strongly Typed Flag Accessors**: Develop a CLI tool to generate strongly typed flag accessors for multiple programming languages. - **Modular and Extensible Design**: Create a format that allows for future extensions and modularization of flags. -## Non-Goals +### Non-Goals - **Full Provider Integration**: The initial scope does not include creating tools to convert provider-specific configurations to the new flag manifest format. - **Validation of Flag Configs**: The project will not initially focus on validating flag configurations for consistency with the flag manifest. -- **General-Purpose Configuration**: The project will not aim to create a general-purpose configuration tool for feature flags beyond the scope of the codegen tool. +- **General-Purpose Configuration**: The project will not aim to create a general-purpose configuration tool for feature flags beyond the scope of the code generation tool. ## Support the project From ec40223b40a29110b37e6e7d1fb56424ac584f24 Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Thu, 31 Oct 2024 14:59:15 -0400 Subject: [PATCH 2/3] Update README.md Signed-off-by: Michael Beemer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4271da7..4563d2a 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ ## Overview -The OpenFeature CLI is a command-line tool designed to improve the developer experience of feature flags. +The OpenFeature CLI is a command-line tool designed to improve the developer experience when working with feature flags. The initial initial version of the CLI focuses on code generation. ## Installation From f59655fa93926df2e7d8d9740e9573d2699dcd75 Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Thu, 31 Oct 2024 15:12:30 -0400 Subject: [PATCH 3/3] Update README.md Signed-off-by: Michael Beemer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4563d2a..91c643a 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ ## Overview The OpenFeature CLI is a command-line tool designed to improve the developer experience when working with feature flags. -The initial initial version of the CLI focuses on code generation. +Currently, features are focused primarily on supporting code generation. ## Installation