Skip to content

Commit 6f42363

Browse files
committed
[fix] errors
1 parent 6c35d52 commit 6f42363

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,61 @@
11
# Etcd.Microsoft.Extensions.Configuration
22

3-
[![Nuget Version](https://img.shields.io/nuget/v/Etcd.Microsoft.Extensions.Configuration)](https://www.nuget.org/packages/Etcd.Microsoft.Extensions.Configuration/)
4-
[![Nuget Download](https://img.shields.io/nuget/dt/Etcd.Microsoft.Extensions.Configuration)](https://www.nuget.org/packages/Etcd.Microsoft.Extensions.Configuration/)
3+
[![NuGet Version](https://img.shields.io/nuget/v/Etcd.Microsoft.Extensions.Configuration)](https://www.nuget.org/packages/Etcd.Microsoft.Extensions.Configuration/)
4+
[![NuGet Download](https://img.shields.io/nuget/dt/Etcd.Microsoft.Extensions.Configuration)](https://www.nuget.org/packages/Etcd.Microsoft.Extensions.Configuration/)
55
[![Build Package](https://github.com/SimplifyNet/Etcd.Microsoft.Extensions.Configuration/actions/workflows/build.yml/badge.svg)](https://github.com/SimplifyNet/Etcd.Microsoft.Extensions.Configuration/actions/workflows/build.yml)
66
[![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/nuget/Etcd.Microsoft.Extensions.Configuration)](https://libraries.io/nuget/Etcd.Microsoft.Extensions.Configuration)
77
[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/SimplifyNet/Etcd.Microsoft.Extensions.Configuration)](https://www.codefactor.io/repository/github/simplifynet/Etcd.Microsoft.Extensions.Configuration)
88
![Platform](https://img.shields.io/badge/platform-.NET%209.0%20%7C%20.NET%208.0-lightgrey)
99
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)](http://makeapullrequest.com)
1010

11-
Etcd based configuration provider for Microsoft.Extensions.Configuration.
11+
Etcd-based configuration provider for Microsoft.Extensions.Configuration.
1212

13-
> Keep in mind that starting from v2 it will work only under Windows 10 or Windows Server 2016 (or later) because of internal Grpc client uses HTTP/2 protocol for communication (<https://docs.microsoft.com/en-us/answers/questions/310032/2012-r2-net-core-http2.html>).
13+
> Keep in mind that starting from v2, it will work only under Windows 10 or Windows Server 2016 (or later) because the internal gRPC client uses the HTTP/2 protocol for communication (<https://docs.microsoft.com/en-us/answers/questions/310032/2012-r2-net-core-http2.html>).
1414
15-
## Quick start
15+
## Quick Start
1616

1717
### HTTP
1818

1919
```csharp
20-
var config = new ConfigurationBuilder()
20+
var config = new ConfigurationBuilder()
2121
.AddEtcd(
22-
new Credentials("MyEtcdUserName", "passw"),
23-
new EtcdSettings("http://serveraddress:2379"))
22+
new Credentials("MyEtcdUserName", "passw"),
23+
new EtcdSettings("http://serveraddress:2379"))
2424
.Build();
2525

26-
var mySection = config.GetSection("MySection");
27-
var myKeyValue = mySection["MyKeyName"];
26+
var mySection = config.GetSection("MySection");
27+
var myKeyValue = mySection["MyKeyName"];
2828
```
2929

3030
### HTTPS
3131

32-
When using HTTPS, *.crt CA certificate (should be provided by etcd administrator) should be placed in well known system certificate store (depending on OS).
32+
When using HTTPS, a *.crt CA certificate (provided by the etcd administrator) should be placed in a well-known system certificate store (depending on the OS).
3333

34-
* For Windows it is `Trusted Root Certification Authority`.
35-
* For Linux, at least for Arch/Manjaro Linux it should be placed in : `/etc/ca-certificates/trust-source/anchors/` followed by `sudo trust extract-compat` command
34+
* For Windows, it is `Trusted Root Certification Authority`.
35+
* For Linux, at least for Arch/Manjaro Linux, it should be placed in `/etc/ca-certificates/trust-source/anchors/`, followed by the `sudo trust extract-compat` command.
3636

37-
### HTTPS with settings from local JSON file
37+
### HTTPS with Settings from a Local JSON File
3838

3939
appsettings.json
4040

4141
```json
4242
{
43-
"EtcdSettings":
44-
{
43+
"EtcdSettings": {
4544
"ConnectionString": "https://serveraddress:2379"
4645
}
4746
}
4847
```
4948

5049
```csharp
5150
var jsonConfig = new ConfigurationBuilder()
52-
.AddJsonFile("appsettings.json")
53-
.Build();
51+
.AddJsonFile("appsettings.json")
52+
.Build();
5453

55-
var config = new ConfigurationBuilder()
56-
.AddEtcd(
57-
new Credentials("MyEtcdUserName", "passw"),
58-
new ConfigurationBasedEtcdSettings(jsonConfig))
59-
.Build();
54+
var config = new ConfigurationBuilder()
55+
.AddEtcd(
56+
new Credentials("MyEtcdUserName", "passw"),
57+
new ConfigurationBasedEtcdSettings(jsonConfig))
58+
.Build();
6059

6160
var mySection = config.GetSection("MySection");
6261
var myKeyValue = mySection["MyKeyName"];
@@ -66,7 +65,7 @@ Settings can be mixed from different locations.
6665

6766
## Contributing
6867

69-
There are many ways in which you can participate in the project. Like most open-source software projects, contributing code is just one of many outlets where you can help improve. Some of the things that you could help out with are:
68+
There are many ways in which you can participate in the project. Like most open-source software projects, contributing code is just one of many ways you can help improve. Some of the things you could help out with are:
7069

7170
* Documentation (both code and features)
7271
* Bug reports
@@ -79,4 +78,4 @@ There are many ways in which you can participate in the project. Like most open-
7978

8079
## License
8180

82-
Licensed under the GNU LESSER GENERAL PUBLIC LICENSE
81+
Licensed under the GNU Lesser General Public License.

0 commit comments

Comments
 (0)