From a23a469fd14478a9148e84a780493ca86434f04f Mon Sep 17 00:00:00 2001
From: Justin Baur <19896123+justindbaur@users.noreply.github.com>
Date: Fri, 15 Nov 2024 19:17:00 -0500
Subject: [PATCH] Add More Details to README

---
 extensions/Bitwarden.Server.Sdk/src/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/extensions/Bitwarden.Server.Sdk/src/README.md b/extensions/Bitwarden.Server.Sdk/src/README.md
index c8ee7ea..b51e678 100644
--- a/extensions/Bitwarden.Server.Sdk/src/README.md
+++ b/extensions/Bitwarden.Server.Sdk/src/README.md
@@ -6,3 +6,13 @@ on your web application and configuring MSBuild properties to configure the feat
 want.
 
 ## Feature Flags
+
+Feature flag support can be added by adding `<BitIncludeFeatures>true</BitIncludeFeatures>` to
+your `csproj` file. The following API's become available:
+
+- `IFeatureService` for getting values of features.
+- `RequireFeatureAttribute` for requiring a feature is enabled on controllers and controller actions.
+- `IEndpointConventionBuilder.RequireFeature()` for requiring a feature is enabled on minimal API's.
+- `IApplicationBuilder.UseFeatureFlagChecks()` for adding the middleware to do the above checks.
+- `IServiceCollection.AddKnownFeatureFlags()` for adding flags that will show up in `IFeatureService.GetAll()`
+- `IServiceCollection.AddFeatureFlagValues()` for adding values for feature flags.