aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ce03f3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Driver Tracing Library
+
+A vendor-neutral, pure-Scala [1] tracing library for Akka-HTTP.
+
+[1] Pure-Scala, in this context, refers to no direct Java library
+dependencies. Dependencies are kept to a minimum, however it is
+possible that Java libraries may be included transitively.
+
+This library provides tracing directives for Akka-HTTP. It specifies
+common client abstractions and implementations that may be used with
+different tracing solutions, such as Google Stackdriver Tracing.
+
+## Getting Started
+TODO
+
+## Tracing Backends
+
+### Logging
+TODO
+
+### Google Stackdriver Tracing
+TODO
+
+