Skip to content

Commit 3054162

Browse files
Update README.md
1 parent e6c9000 commit 3054162

File tree

1 file changed

+48
-2
lines changed

1 file changed

+48
-2
lines changed

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
1-
# appconfi-csharp
2-
Appconfi .NET SDK
1+
# Appconfi
2+
3+
[Appconfi](https://www.appconfi.com) - Service to centrally manage application settings and feature toggles for applications and services.
4+
5+
## Installation
6+
7+
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)
8+
```
9+
Install-Package Appconfi
10+
```
11+
More info is available on [nuget](https://www.nuget.org/packages/Appconfi/)
12+
13+
## Usage
14+
15+
In order to use the Appconfi you will need to [create an account](https://appconfi.com/account/register).
16+
17+
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`.
18+
19+
## How to use
20+
21+
```csharp
22+
23+
var manager = Configuration.NewInstance(applicationId, apiKey);
24+
25+
//Start monitoring changes in your application settings and features toggles.
26+
manager.StartMonitor();
27+
28+
//Access your application settings
29+
var color = manager.GetSetting("application.color");
30+
31+
//Check if your feature toggles are enable
32+
var status = manager.IsFeatureEnabled("you.feature");
33+
34+
```
35+
36+
## Optional parameters
37+
38+
Change your environments:
39+
40+
```csharp
41+
var env = "PRODUCTION";
42+
var refreshInterval = TimeSpan.FromSeconds(10);
43+
var manager = Configuration.NewInstance(applicationId, apiKey, env, refreshInterval);
44+
```
45+
46+
## Links
47+
48+
* [Web](https://appconfi.com)

0 commit comments

Comments
 (0)