Commits

dp wiz committed c3ad276

Update repo frontpage.

Comments (0)

Files changed (1)

-(From http://sentry.readthedocs.org/en/latest/developer/client/index.html)
+Raven is a client for Sentry event server (<https://www.getsentry.com/>).
+
+Start by initializing the raven 'Service':
+
+    l <- initRaven
+          "https://pub:priv@sentry.hostname.tld:8443/sentry/example_project"
+          id
+          sendRecord
+          stderrFallback
+
+Send events using 'register' function:
+
+    register l "my.logger.name" Debug "Hi there!" id
+
+More documentation is in the `System.Log.Raven` package.
+
+-----------------------------------------------------------------------
+
+Dev. checklist
+==============
 
 Writing a Client
-=
+----------------
+
+http://sentry.readthedocs.org/en/latest/developer/client/index.html
 
 A client at its core is simply a set of utilities for capturing various logging parameters. Given these parameters, it then builds a JSON payload which it will send to a Sentry server using some sort of authentication method.
 
   * [m] Logging integration (to whatever standard solution is available)
   * [ ] Non-blocking event submission
   * [m] Basic data sanitization (e.g. filtering out values that look like passwords)
+
+Client Criteria
+---------------
+
+http://sentry.readthedocs.org/en/latest/client/index.html
+
+If you’re developing a client for your platform, there’s several things we highly encourage:
+
+  * It should fully implement the current version of the Sentry protocol.
+  * It should conform to the standard DSN configuration method.
+  * It should contain an acceptable level of documentation and tests.
+  * The client should be properly packaged, and named raven-<platform>.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.