initial setup of java agent project

add git config to project add readme
intergral · May 16, 2023 · d62071f · d62071f
1 parent 731c659
commit d62071f
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 0 deletions.
diff --git a/.idea/git_toolbox_prj.xml b/.idea/git_toolbox_prj.xml
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# DEEP Java Client
+
+DEEP is an open source dynamic insight engine based on the Grafana stack. The idea is to allow dynamic collection of
+Traces, Metrics, Logs and Snapshots via the Grafana UI.
+
+## Usage
+
+To use DEEP simple import the package and start the agent at the earliest point in the code.
+
+```groovy
+import com.intergral.deep.Deep
+
+Deep.start()
+```
+
+## Examples
+
+There are a couple of examples [available here](./examples/README.md).
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,7 @@
+# Examples
+
+Here we have some examples of usage of the DEEP agent.
+
+## Simple-App
+
+This is a very basic app that demonstrates the usage of DEEP.