Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: switch from code gen to cli #47

Merged
merged 3 commits into from
Oct 31, 2024
Merged

docs: switch from code gen to cli #47

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d396bd4
docs: switch from code gen to cli
beeme1mr Oct 31, 2024
ec40223
Update README.md
beeme1mr Oct 31, 2024
f59655f
Update README.md
beeme1mr Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</picture>
</p>

<h2 align="center">OpenFeature CodeGen</h2>
<h2 align="center">OpenFeature CLI</h2>
<!-- x-hide-in-docs-end -->
<!-- The 'github-badges' class is used in the docs -->
<p align="center" class="github-badges">
Expand All @@ -21,28 +21,37 @@
<!-- x-hide-in-docs-start -->

> [!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.
<!-- x-hide-in-docs-end -->

## 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 when working with feature flags.
Currently, features are focused primarily on supporting 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

Expand Down