|
1 | | -# OpenFeature Specification |
| 1 | +<!-- markdownlint-disable MD033 --> |
| 2 | +<!-- x-hide-in-docs-start --> |
| 3 | +<p align="center"> |
| 4 | + <picture> |
| 5 | + <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg" /> |
| 6 | + <img align="center" alt="OpenFeature Logo" src="https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg" /> |
| 7 | + </picture> |
| 8 | +</p> |
2 | 9 |
|
3 | | -[](https://github.com/orgs/open-feature/projects/1) [](https://github.com/open-feature/.github/blob/main/CONTRIBUTING.md) [](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md) |
| 10 | +<h2 align="center">OpenFeature Specification</h2> |
4 | 11 |
|
5 | | -This repository describes the requirements and expectations for OpenFeature. |
| 12 | +<!-- x-hide-in-docs-end --> |
| 13 | +<!-- The 'github-badges' class is used in the docs --> |
| 14 | +<p align="center" class="github-badges"> |
| 15 | + <a href="https://github.com/orgs/open-feature/projects/1"> |
| 16 | + <img alt="Roadmap" src="https://img.shields.io/static/v1?label=Roadmap&message=public&color=green" /> |
| 17 | + </a> |
| 18 | + <a href="https://github.com/open-feature/.github/blob/main/CONTRIBUTING.md"> |
| 19 | + <img alt="Contributing" src="https://img.shields.io/static/v1?label=Contributing&message=guide&color=blue" /> |
| 20 | + </a> |
| 21 | + <a href="https://cloud-native.slack.com/archives/C0344AANLA1"> |
| 22 | + <img alt="Slack" src="https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack"/> |
| 23 | + </a> |
| 24 | + <a href="https://bestpractices.coreinfrastructure.org/projects/6601"> |
| 25 | + <img alt="CII Best Practices" src="https://bestpractices.coreinfrastructure.org/projects/6601/badge" /> |
| 26 | + </a> |
| 27 | +</p> |
| 28 | +<!-- x-hide-in-docs-start --> |
| 29 | + |
| 30 | +[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. |
6 | 31 |
|
7 | | -> :warning: Ongoing research can be found in the [research repo](https://github.com/open-feature/research). For definitions of key terminology, see the [glossary](./specification/glossary.md). |
| 32 | +This repository describes the requirements and expectations for OpenFeature. |
8 | 33 |
|
9 | 34 | ## Design Principles |
10 | 35 |
|
11 | | -- Compatibility with existing feature flag offerings |
12 | | -- Simple, understandable APIs |
13 | | -- Vendor agnosticism |
14 | | -- Language agnosticism |
15 | | -- Low/no dependency |
16 | | -- Extensibility |
| 36 | +The OpenFeature specification must be designed with: |
| 37 | + |
| 38 | +- compatibility with existing feature flag offerings. |
| 39 | +- simple, understandable APIs. |
| 40 | +- vendor agnosticism. |
| 41 | +- language agnosticism. |
| 42 | +- low/no dependency. |
| 43 | +- extensibility. |
17 | 44 |
|
18 | 45 | ### SDKs and Client Libraries |
19 | 46 |
|
20 | | -The project aims to provide a unified API and SDK for feature flag management in various technology stacks. |
| 47 | +The project aims to provide a unified API and SDK feature flag evaluation across popular technology stacks. |
21 | 48 | The OpenFeature SDK provides a mechanism for interfacing |
22 | 49 | with an external evaluation engine in a vendor agnostic way; |
23 | 50 | it does **not** itself handle the flag evaluation logic. |
24 | 51 |
|
25 | | -The OpenFeature project will include client libraries for common technology stacks including, but not limited to: |
26 | | - |
27 | | -- Golang |
28 | | -- Java |
29 | | -- JavaScript/TypeScript (Node.js) |
| 52 | +An up-to-date SDK compatibility overview can be found [here](https://openfeature.dev/docs/reference/technologies/sdk-compatibility). |
30 | 53 |
|
31 | 54 | ### Tooling |
32 | 55 |
|
|
0 commit comments