Skip to content

Commit ef246ef

Browse files
author
onetrueerror
committed
Updated the readme
1 parent 305ec4c commit ef246ef

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
1-
# OneTrueError.Client.AspNet
2-
Client library for ASP.NET based applications (other than WebApi and MVC)
1+
Integration library for ASP.NET applications
2+
==========================
3+
4+
This library will detect all unhandled exceptions in ASP.NET-based applications and report them to your OneTrueError server (or your account at https://onetrueerror.com).
5+
6+
If you want to get automated handling for one of the ASP.NET derivatives, use the following libraries:
7+
8+
* [ASP.NET MVC5](https://github.com/onetrueerror/onetrueerror.client.aspnet.mvc5)
9+
* [ASP.NET WebApi2](https://github.com/onetrueerror/onetrueerror.client.aspnet.webapi2)
10+
11+
12+
To report exceptions manually in your controller, use `OneTrue.Report(exception)`, OneTrueError will include information about the HttpRequest, QueryString, Form, Session etc when your exception is reported.
13+
14+
# Context collections
15+
16+
This library includes the following context collections for every reported exceptions:
17+
18+
* All in the [core library](https://github.com/onetrueerror/onetrueerror.client)
19+
* Application collection
20+
* Form data
21+
* Http headers
22+
* Query string parameters
23+
* Session data
24+
* Uploaded files
25+
26+
# Getting started
27+
28+
1. Download and install the [OneTrueError server](https://github.com/onetrueerror/onetrueerror.server) or create an account at [OneTrueError.com](https://onetrueerror.com)
29+
2. Install this client library (using nuget `onetrueerror.client.aspnet`)
30+
3. Configure the credentials from your OneTrueError account in your `Global.asax`
31+
4. Add `OneTrue.Configuration.CatchAspNetExceptions()` in your `Global.asax`
32+
33+
Done.

0 commit comments

Comments
 (0)