-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e6c9000
commit 3054162
Showing
1 changed file
with
48 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,48 @@ | ||
# appconfi-csharp | ||
Appconfi .NET SDK | ||
# Appconfi | ||
|
||
[Appconfi](https://www.appconfi.com) - Service to centrally manage application settings and feature toggles for applications and services. | ||
|
||
## Installation | ||
|
||
The Appconfi .NET SDK is available as a Nuget package, to install run the following command in the [Package Manager Console](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio) | ||
``` | ||
Install-Package Appconfi | ||
``` | ||
More info is available on [nuget](https://www.nuget.org/packages/Appconfi/) | ||
|
||
## Usage | ||
|
||
In order to use the Appconfi you will need to [create an account](https://appconfi.com/account/register). | ||
|
||
From there you can create your first application and setup your configuration. To use the Appconfi API to access your configuration go to `/accesskeys` there you can find the `application_id` and your `application_secret`. | ||
|
||
## How to use | ||
|
||
```csharp | ||
|
||
var manager = Configuration.NewInstance(applicationId, apiKey); | ||
|
||
//Start monitoring changes in your application settings and features toggles. | ||
manager.StartMonitor(); | ||
|
||
//Access your application settings | ||
var color = manager.GetSetting("application.color"); | ||
|
||
//Check if your feature toggles are enable | ||
var status = manager.IsFeatureEnabled("you.feature"); | ||
|
||
``` | ||
|
||
## Optional parameters | ||
|
||
Change your environments: | ||
|
||
```csharp | ||
var env = "PRODUCTION"; | ||
var refreshInterval = TimeSpan.FromSeconds(10); | ||
var manager = Configuration.NewInstance(applicationId, apiKey, env, refreshInterval); | ||
``` | ||
|
||
## Links | ||
|
||
* [Web](https://appconfi.com) |