Finish API docs

License

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Felix Geisendörfer ([email protected])
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.

Readme.md

@@ -29,10 +29,10 @@ manually submit errors to airbreak.
 ``` javascript
 var airbreak = require('airbrake').createClient("your api key");
 var err = new Error('Something went terribly wrong');
-airbrake.notify(err, function(err) {
+airbrake.notify(err, function(err, url) {
   if (err) throw err;
 
-  // Error has been delivered
+  // Error has been delivered, url links to the error in airbreak
 });
 ```
 
@@ -98,3 +98,48 @@ airbrake.on('vars', function(type, vars) {
 ```
 
 ## API
+
+### Airbreak.createClient(apiKey, [env])
+
+Returns a new Airbrake instance.
+
+### airbrake.key = null
+
+The API key to use.
+
+### airbrake.env = process.env.NODE_ENV;
+
+The name of the server environment this is running in.
+
+### airbrake.projectRoot = null
+
+The root directory of this project.
+
+### airbrake.appVersion = null
+
+The version of this app. Set to a semantic version number, or leave unset.
+
+### airbrake.protocol = 'http'
+
+The protocol to use.
+
+### airbrake.handleExceptions()
+
+Registers a `process.on('uncaughtException')` listener. When an uncaught
+exception occurs, the error is send to airbrake, and then re-thrown to
+kill the process.
+
+### airbrake.notify(err, [cb])
+
+Sends the given `err` to airbrake.
+
+The callback parameter receives two arguments, `err, url`. `err` is set if
+the delivery to airbrake failed.
+
+If no `cb` is given, and the delivery fails, an `error` event is emitted. If
+there is no listener for this event, node will kill the process as well. This
+is done to avoid silent error delivery failure.
+
+## License
+
+airbrake is licensed under the MIT license.