From 0dd0b60d031a61b9b6f480c024ae45bc44a81da0 Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Tue, 23 Jan 2024 10:02:38 -0500 Subject: [PATCH 1/4] update readme to be pure markdown Signed-off-by: Michael Beemer --- README.md | 51 +++++++++++++-------------------------------------- 1 file changed, 13 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index a2db7e76..ae0b3a83 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,21 @@ -

- - - OpenFeature Logo - -

+![OpenFeature Light Logo](https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg#gh-dark-mode-only) +![OpenFeature Dark Logo](https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg#gh-light-mode-only) -

OpenFeature .NET SDK

+## .NET SDK - -

- - Specification - - - - - Release - - -
- - Slack - - - Codecov - - - NuGet - - - CII Best Practices - - -

+![Specification](https://img.shields.io/static/v1?label=specification&message=v0.5.2&color=yellow&style=for-the-badge) +![Release](https://img.shields.io/static/v1?label=release&message=v1.4.0&color=blue&style=for-the-badge) + +![Slack](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack) +![Codecov](https://codecov.io/gh/open-feature/dotnet-sdk/branch/main/graph/badge.svg?token=MONAVJBXUJ) +![NuGet](https://img.shields.io/nuget/vpre/OpenFeature) +![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6250/badge) -[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. +[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. @@ -100,7 +77,7 @@ public async Task Example() | ✅ | [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. | | ✅ | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. | -Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌ +_Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌_ ### Providers @@ -334,9 +311,7 @@ Interested in contributing? Great, we'd love your help! To get started, take a l ### Thanks to everyone who has already contributed - - - +![Contrib Rocks](https://contrib.rocks/image?repo=open-feature/dotnet-sdk) Made with [contrib.rocks](https://contrib.rocks). From 991796c952e666109600e428d31b5bcf01720f7d Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Tue, 23 Jan 2024 10:17:22 -0500 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Austin Drenski Signed-off-by: Michael Beemer --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ae0b3a83..decb2c56 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ ## .NET SDK -![Specification](https://img.shields.io/static/v1?label=specification&message=v0.5.2&color=yellow&style=for-the-badge) -![Release](https://img.shields.io/static/v1?label=release&message=v1.4.0&color=blue&style=for-the-badge) +[![Specification](https://img.shields.io/static/v1?label=specification&message=v0.5.2&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.5.2) +[![Release](https://img.shields.io/static/v1?label=release&message=v1.4.0&color=blue&style=for-the-badge)](https://github.com/open-feature/dotnet-sdk/releases/tag/v1.4.0) -![Slack](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack) -![Codecov](https://codecov.io/gh/open-feature/dotnet-sdk/branch/main/graph/badge.svg?token=MONAVJBXUJ) -![NuGet](https://img.shields.io/nuget/vpre/OpenFeature) -![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6250/badge) +[![Slack](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1) +[![Codecov](https://codecov.io/gh/open-feature/dotnet-sdk/branch/main/graph/badge.svg?token=MONAVJBXUJ)](https://codecov.io/gh/open-feature/dotnet-sdk) +[![NuGet](https://img.shields.io/nuget/vpre/OpenFeature)](https://www.nuget.org/packages/OpenFeature) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6250/badge)](https://www.bestpractices.dev/en/projects/6250) [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. @@ -311,7 +311,7 @@ Interested in contributing? Great, we'd love your help! To get started, take a l ### Thanks to everyone who has already contributed -![Contrib Rocks](https://contrib.rocks/image?repo=open-feature/dotnet-sdk) +[![Contrib Rocks](https://contrib.rocks/image?repo=open-feature/dotnet-sdk)](https://github.com/open-feature/dotnet-sdk/graphs/contributors) Made with [contrib.rocks](https://contrib.rocks). From c1668fff9d32bf0fd1d20e1f0f0221e1e3b76629 Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Tue, 23 Jan 2024 10:20:53 -0500 Subject: [PATCH 3/4] readded the release please tag Signed-off-by: Michael Beemer --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index decb2c56..db7d146c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ [![Specification](https://img.shields.io/static/v1?label=specification&message=v0.5.2&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.5.2) -[![Release](https://img.shields.io/static/v1?label=release&message=v1.4.0&color=blue&style=for-the-badge)](https://github.com/open-feature/dotnet-sdk/releases/tag/v1.4.0) +[![Release](https://img.shields.io/static/v1?label=release&message=v1.4.0&color=blue&style=for-the-badge)](https://github.com/open-feature/dotnet-sdk/releases/tag/v1.4.0) + [![Slack](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1) [![Codecov](https://codecov.io/gh/open-feature/dotnet-sdk/branch/main/graph/badge.svg?token=MONAVJBXUJ)](https://codecov.io/gh/open-feature/dotnet-sdk) From 91f29836b9b2f8dca0012c5aba3216e976aea64b Mon Sep 17 00:00:00 2001 From: Michael Beemer Date: Tue, 23 Jan 2024 10:42:28 -0500 Subject: [PATCH 4/4] remove dark mode support from readme Signed-off-by: Michael Beemer --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index db7d146c..0f620a38 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -![OpenFeature Light Logo](https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/white/openfeature-horizontal-white.svg#gh-dark-mode-only) -![OpenFeature Dark Logo](https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg#gh-light-mode-only) + +![OpenFeature Dark Logo](https://raw.githubusercontent.com/open-feature/community/0e23508c163a6a1ac8c0ced3e4bd78faafe627c7/assets/logo/horizontal/black/openfeature-horizontal-black.svg) ## .NET SDK