Skip to content

Commit a4baa81

Browse files
authored
Fixing headings on readme.md
1 parent 66476d3 commit a4baa81

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
##Stackify API for .NET
1+
## Stackify API for .NET
22

33
Library for Stackify users to integrate Stackify in to their projects. Provides support for sending errors, logs, and custom metrics to Stackify. Also some support for querying metric data back out of Stackify for use in external projects.
44

@@ -19,7 +19,7 @@ Library for Stackify users to integrate Stackify in to their projects. Provides
1919
- [Direct API](#direct-api)
2020
- [Configuring with Azure service definitions](#configuring-with-azure-service-definitions)
2121

22-
##Basics
22+
## Basics
2323

2424
Several nuget packages are available for Stackify's core API as well as various logging frameworks. Please install the proper packages. All of the available packages for various logging frameworks are wrapper on top of StackifyLib which can also be used directly for logging.
2525

@@ -73,12 +73,12 @@ If you are having problems you can get logging out of the framework by hooking i
7373

7474
Please note that Newtonsoft.Json is used by StackifyLib but is embedded as a resource to avoid version conflicts. Costura.Fody is being used to embed it. If you have any issues with Newtonsoft.Json as a result of using StackifyLib please contact Stackify support.
7575

76-
##Errors and Logs
76+
## Errors and Logs
7777

7878
If you log an object with the message, Stackify's log viewer makes it easy to search by these parameters. You can always search by the text in the log message itself, but searching by the logged properties provides a lot more power. If you always logged a "clientid" for example on every log message, you could search in Stackify for "json.clientid:1" and quickly see all logs and errors affecting that specific client. Another big difference and advantage to logging objects is you can do a range type search "json.clientid:[1 TO 10]" which would not be possible by a straight text search.
7979

8080

81-
###NLog 2.0.1.2 - v3.1+
81+
### NLog 2.0.1.2 - v3.1+
8282

8383
**Install via NuGet package**
8484
```
@@ -114,7 +114,7 @@ Options
114114
- CallContextKeys is an additional feature unrelated to NLog that uses the local thread storage for more advanced tracking of context variables. It is used via CallContext.LogicalSetData(key, value). Research LogicalSetData online to learn more. It is supposed to work better across child Task objects and with async.
115115
- logMethodNames - Method names will show up in the StackifyLog viewer most of the time as the class name that did the logging. For exceptions it will usually show the method name. To enable the exact method name for all logging, set this property to true. Note that it does cause a small performance hit due to walking the StackTrace.
116116

117-
###log4net v2.0+ (v1.2.11+)
117+
### log4net v2.0+ (v1.2.11+)
118118

119119
**Install via NuGet package**
120120
```
@@ -161,7 +161,7 @@ Options
161161
- logMethodNames - Method names will show up in the StackifyLog viewer most of the time as the class name that did the logging. For exceptions it will usually show the method name. To enable the exact method name for all logging, set this property to true. Note that it does cause a small performance hit due to walking the StackTrace.
162162

163163

164-
####log4net Extension Methods
164+
#### log4net Extension Methods
165165

166166
log4net does not internally have methods for logging a log message along with an object. Stackify's appenders work fine if you log an object directly or we have created some friendly extension methods to make it easy to log an object with your message at the same time.
167167

@@ -174,7 +174,7 @@ log4net does not internally have methods for logging a log message along with an
174174
logger.Debug(dictionary); //This works fine and is indexed and searchable by Stackify
175175
logger.Debug("Starting some process for client 1", dictionary); //extension method
176176

177-
###log4net v1.2.10
177+
### log4net v1.2.10
178178

179179
**Install via NuGet package**
180180
```
@@ -184,7 +184,7 @@ PM> Install-Package StackifyLib.log4net.v1_2_10
184184
Note: If you use 1.2.10 then you must use our special nuget package for that version. There is no way to use an assembly redirect because the public key of log4net v1 and v2 are different. Everything else is the same about using log4net with Stackify.
185185

186186

187-
###Direct API
187+
### Direct API
188188

189189
**Install via NuGet package**
190190
```
@@ -209,7 +209,7 @@ If you use a custom logging framework or a framework not currently supported, yo
209209

210210
*Make sure you call StackifyLib.Logger.Shutdown() before your app ends to flush the queue*
211211

212-
###Configuring with Azure service definitions
212+
### Configuring with Azure service definitions
213213

214214
StackifyLib reads the license key, app name, and environment settings from normal web.config appSettings. If you would prefer to store the settings in an [azure cloud deployment cscfg](http://msdn.microsoft.com/en-us/library/azure/hh369931.aspx#NameValue), then you can create a little code to read the settings from there and set the StackifyLib settings in code like this in some similar way.
215215

0 commit comments

Comments
 (0)