Blob Blame History Raw
From aae392dd807e84b8742c42cd40090a0e25c6b7d3 Mon Sep 17 00:00:00 2001
From: Jakub Filak <jfilak@redhat.com>
Date: Mon, 2 Dec 2013 16:49:30 +0100
Subject: [PATCH 14/39] Add an abstract to README

Related to rhbz#1055581
---
 README | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README b/README
index f9545bd..bf0f8f3 100644
--- a/README
+++ b/README
@@ -1,6 +1,17 @@
 README
 ------
 
+ABRT Java Connector is a JVM agent which reports a Java exceptions to ABRT. The
+agent can report both caught and uncaught exceptions but by default it reports
+only uncaught exceptions. In order to be able to report even uncaught
+exceptions, the agent must register several JVMTI event callbacks and the
+processing inside of those callbacks have not-insignificant impact on the
+performance of an entire application.
+
+
+Usage
+-----
+
 It needs to be compiled as a shared native library (.so) and then loaded into
 JVM using -agentlib command line parameter.
 
-- 
1.8.3.1