aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jakob@driver.xyz>2017-10-01 23:48:40 -0700
committerJakob Odersky <jakob@driver.xyz>2017-10-01 23:48:40 -0700
commit7f4a7648894be1f07300f6d66f00ff443dc83826 (patch)
treed159fb4d5279699831d372c7dc55499e5b63b9ca
parent94b2f99bafca1b59e1f7e31d417d624eede2af96 (diff)
downloadtracing-7f4a7648894be1f07300f6d66f00ff443dc83826.tar.gz
tracing-7f4a7648894be1f07300f6d66f00ff443dc83826.tar.bz2
tracing-7f4a7648894be1f07300f6d66f00ff443dc83826.zip
Add readme
-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
+
+