Skip to content

Commit acb116b

Browse files
authored
Update README.md
Added detailed description of samples.
1 parent 96b989f commit acb116b

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,19 @@ If needed it is possible to control how and where the `ServiceFabricConfigProvid
130130
**NOTE: The parameter name attribute in Settings.xml representing the feature toggle must match the name of the class representing the feature toggle, and unless disabled (see above) it must be prefixed with FeatureToggle.**
131131

132132
## Samples
133-
[walkthrough of sample to be added]
133+
The samples folder contains a single *Samples.sln* solution containing samples of the 3 FeatureToggle providers from the **FeatureToggle.Azure** packages. In order try these out locally, the following must be installed:
134+
- Service Fabric SDK with local cluster setup which can be downloaded through [Web Platform Installer](https://www.microsoft.com/web/downloads/platform.aspx)
135+
- [Cosmos DB Emulator](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator)
136+
- [Azure Storage Emulator](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-emulator)
137+
138+
### ASP.NET Web App sample
139+
The project *WebApplication* is a standard ASP.NET Web App (.NET Framework) showing how to configure and use **FeatureToggle.Azure.DocumentDB** and **FeatureToggle.Azure.TableStorage**. The configuration of the providers is located in the `Global.asax.cs`file. Both providers are configured for using local emulators with auto creation of storage and toggles.
140+
141+
Feature toggles are found in the FeatureToggle folder and are used in the `HomeController`. The `FrontPageUIFeature` toggles a message on the front page of the web app and is stored in Table Storage (emulator). The `AboutPageFeature` toggles a message on the About page of the web app and is stored in DocumentDb (emulator). In order to change the toggle values after creation, you can use the Cloud Explorer in Visual Studio or the Azure Storage Explorer.
142+
143+
### ASP.NET Core sample running in Service Fabric
144+
The project *SfWebAppCore* is a ASP.NET Core Web App packaged as a Service Fabric application (the *ServiceFabricApplication* project). This sample shows how to configure and use **FeatureToggle.Azure.ServiceFabric**. The optional configuration of the provider is located in the `Startup.cs` file. The configuration package is located in PackageRoot/Config/Settings.xml file of the *SfWebAppCore* project.
145+
146+
Feature toggles are found in the FeatureToggles folder and are used in the `HomeController`. The `CoolNewFeatureToggle` toggles a message on the About page of the web app. In order to toggle the value, the configuration package must be [packaged](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-package-apps) and [deployed](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-deploy-remove-applications) to the local cluster.
147+
148+

0 commit comments

Comments
 (0)