X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;fp=docs%2Foverview.rst;h=770ae8dc475e3e85423771a68f5b681a790bd88b;hb=df2cd95778b08cc29e2e2e9f4d2e690ed43fd42e;hp=0000000000000000000000000000000000000000;hpb=ddcdb2e4318b9150352f15a7263024fff1ed41e2;p=ric-plt%2Ftracelibgo.git

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644
index 0000000..770ae8d
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,34 @@
+..
+.. Copyright (c) 2019 AT&T Intellectual Property.
+..
+.. Copyright (c) 2019 Nokia.
+..
+..
+.. Licensed under the Creative Commons Attribution 4.0 International
+..
+.. Public License (the "License"); you may not use this file except
+..
+.. in compliance with the License. You may obtain a copy of the License at
+..
+..
+..     https://creativecommons.org/licenses/by/4.0/
+..
+..
+.. Unless required by applicable law or agreed to in writing, documentation
+..
+.. distributed under the License is distributed on an "AS IS" BASIS,
+..
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+..
+.. See the License for the specific language governing permissions and
+..
+.. limitations under the License.
+..
+
+
+tracelibgo Overview
+===================
+
+This library implements a function for creating a configured tracer instance.
+It hides the underlaying tracer implementation from the application.
+The trace library currently supports only Jaeger (https://www.jaegertracing.io/) golang client (https://github.com/jaegertracing/jaeger-client-go) tracer implementation.
\ No newline at end of file