Skip to content
This repository has been archived by the owner on Aug 30, 2023. It is now read-only.

Commit

Permalink
doc: sentry logo and extras (#250)
Browse files Browse the repository at this point in the history
* doc: sentry logo and extras
  • Loading branch information
bruno-garcia authored May 10, 2018
1 parent d8e6938 commit 0b5adba
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# SharpRaven
<p align="center">
<a href="https://sentry.io" target="_blank" align="center">
<img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
</a>
<br />
</p>

SharpRaven is the .NET client for [Sentry](https://getsentry.com/welcome/).
Official [Sentry](https://sentry.io/for/csharp/) SDK for .NET.
===========

| | Stable | Pre-release |
| -------------------: | :----------------------------: | :------------------: |
Expand All @@ -11,10 +17,10 @@ SharpRaven is the .NET client for [Sentry](https://getsentry.com/welcome/).
| **AppVeyor Build** | [![Master][9]][10] | [![Develop][15]][10] |

## Usage
Instantiate the client with your DSN:
Instantiate the client with your 'Data Source Name' (DSN):

```csharp
var ravenClient = new RavenClient("http://public:[email protected]/project-id");
var ravenClient = new RavenClient("https://public@sentry.io/project-id");
```

### Capturing Exceptions
Expand Down Expand Up @@ -63,7 +69,7 @@ sent with your request, such as `ErrorLevel`, `Fingerprint`, a custom `Message`
and `Tags`.

### Async Support
In the .NET 4.5 build of SharpRaven, there's an `async` version of the `Capture`
In the .NET 4.5 or later build of SharpRaven, there's an `async` version of the `Capture`
method as well:

```csharp
Expand All @@ -82,7 +88,7 @@ instance of the `Dsn` class in your container:
```csharp
protected override void ApplicationStartup(TinyIoCContainer container, IPipelines pipelines)
{
container.Register(new Dsn("http://public:[email protected]/project-id"));
container.Register(new Dsn("https://public@sentry.io/project-id"));
}
```

Expand All @@ -94,7 +100,7 @@ or through configuration:
<section name="sharpRaven" type="SharpRaven.Nancy.NancyConfiguration, SharpRaven.Nancy" />
</configSections>
<sharpRaven>
<dsn value="http://public:[email protected]/project-id" />
<dsn value="https://public@sentry.io/project-id" />
</sharpRaven>
</configuration>
```
Expand Down Expand Up @@ -148,8 +154,11 @@ with prebuilt binaries, there's NuGet packages of both
## Resources
* [![Join the chat at https://gitter.im/getsentry/raven-csharp][gitter-badge]][gitter-link]
* [Code][github]
* [Bug Tracker](https://github.com/getsentry/raven-csharp/issues)
* [Forum][forum]
* [Mailing List][mail]
* [IRC][irc] (`#sentry` on `irc.freenode.net`)
* Follow [@getsentry](https://twitter.com/getsentry) on Twitter for updates

[1]: https://img.shields.io/github/release/getsentry/raven-csharp.svg
[2]: https://github.com/getsentry/raven-csharp/releases/latest
Expand All @@ -168,8 +177,9 @@ with prebuilt binaries, there's NuGet packages of both
[ex]: https://msdn.microsoft.com/en-us/library/system.exception.data.aspx
[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
[gitter-link]: https://gitter.im/getsentry/raven-csharp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[github]: http://github.com/getsentry/raven-csharp
[github]: http://github.com/getsentry/raven-csharp/develop/src
[mail]: https://groups.google.com/group/getsentry
[forum]: https://forum.sentry.io/c/sdks
[irc]: irc://irc.freenode.net/sentry
[nuget]: https://www.nuget.org/packages/SharpRaven
[nuget-nancy]: https://www.nuget.org/packages/SharpRaven.Nancy
Expand Down

0 comments on commit 0b5adba

Please sign in to comment.