Skip to content

Commit bc96473

Browse files
authored
Update README.md
1 parent ee0e983 commit bc96473

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ It was developed to be integrated to .Net Core 2 logging abstractions.
99

1010
### Features
1111

12-
* ILoggers (**HEC** (*Raw* and *Json*) and **Socket** (*TCP* and *UDP*)
12+
* ILoggers **HEC** (*Raw* and *Json*) and **Socket** (*TCP* and *UDP*)
1313
* Batch Manager class (Improve **Splunk** *HEC* performance sending data as batch)
1414

1515
## Usage
1616

17-
After add *SplunkLogger* nuget library
17+
Add *SplunkLogger* nuget library
1818
```powershell
1919
PM> Install-Package SplunkLogger
2020
```
2121

22-
You should initialize a new *SplunkLoggerConfiguration* and the logger provider at **Configure** method at **Startup** class:
22+
Initialize a new *SplunkLoggerConfiguration* and the logger provider at **Configure** method at **Startup** class:
2323

2424
```csharp
2525
static readonly ILoggerFormatter formatter = null;
@@ -39,9 +39,9 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
3939
}
4040
```
4141

42-
In this case above we added a **Splunk** *HEC Raw* logger without any custom formmater as log provider.
42+
The case above is using a **Splunk** *HEC Raw* logger without any custom formatter as log provider.
4343

44-
Now in your controller you can log normally, for instance:
44+
Now, in your controller you can log normally, for instance:
4545

4646
```csharp
4747
[Route("api/[controller]")]
@@ -67,9 +67,9 @@ public class ValuesController : Controller
6767
-------------------------------------------
6868

6969
# VTEXSplunkLogger
70-
For us at **VTEX** we need more customized log entries at Splunk and also we need easier ways to call for log registration during the code and for that we created this *VTEXSplunkLogger* library.
70+
For us at **VTEX** we need more customized log entries at Splunk and also we need easier ways to call for log registration during the code. For that, we created this *VTEXSplunkLogger* library.
7171

72-
This project contains all **VTEX** extra classes designed to facilitate to log registration and also, all classes to customize .Net Core 2 log abstraction to a customized log entry at **Splunk**
72+
This project contains all **VTEX** extra classes designed ease logging. All classes changes .Net Core 2 log abstraction to a customized log entry at **Splunk**
7373

7474
| Package Name | Release |
7575
|--------------------------------|-----------------|
@@ -79,17 +79,17 @@ This project contains all **VTEX** extra classes designed to facilitate to log r
7979

8080
* ILoggerExtensions (*Allow easy log creation*)
8181
* LoggerFactoryExtensions (*Simplify loggerFactory add provider method call*)
82-
* VTEXSplunkLoggerFormatter (*Custom `ILoggerFormatter` responsable for create VTEX custom text to Splunk*)
82+
* VTEXSplunkLoggerFormatter (*Custom `ILoggerFormatter` which creates VTEX's custom text to Splunk*)
8383

8484

8585
## Usage
8686

87-
After add *VTEXSplunkLogger* nuget library
87+
Add *VTEXSplunkLogger* nuget library
8888
```powershell
8989
PM> Install-Package VTEXSplunkLogger -Source https://www.myget.org/F/vtexlab/api/v3/index.json
9090
```
9191

92-
You should initialize a new *SplunkLoggerConfiguration* and the logger provider at **Configure** method at **Startup** class:
92+
Initialize a new *SplunkLoggerConfiguration* and the logger provider at **Configure** method at **Startup** class:
9393

9494
```csharp
9595
static readonly ILoggerFormatter formatter = new VTEXSplunkLoggerFormatter();
@@ -111,7 +111,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
111111

112112
```csharp
113113
using Vtex;
114-
//other usings ..
114+
// other usings ..
115115
116116
[Route("api/[controller]")]
117117
public class ValuesController : Controller

0 commit comments

Comments
 (0)