Add readme file

Author: NathanielRN

sdk-extension/opentelemetry-sdk-extension-aws/README.md

@@ -0,0 +1,50 @@
+OpenTelemetry SDK Extension for AWS X-Ray Compatibility
+=======================================================
+
+TODO: Deploy this package to Pypi
+
+
+This library provides components necessary to configure the OpenTelemetry SDK
+for tracing with AWS X-Ray.
+
+Installation
+------------
+
+::
+
+    pip install opentelemetry-sdk-extension-aws
+
+
+Usage (Simple Console Export)
+-----------------------------
+
+Set this environment variable to use the provided AWS X-Ray Propagator:
+
+::
+
+    export OTEL_PYTHON_PROPAGATORS = aws_xray
+
+Then, begin tracing like so:
+
+.. code-block:: python
+
+    from opentelemetry.sdk.extension.aws.trace import AWSXRayIdsGenerator
+
+    span_processor = SimpleExportSpanProcessor(ConsoleSpanExporter())
+    trace.set_tracer_provider(
+        TracerProvider(
+            active_span_processor=span_processor,
+            ids_generator=AWSXRayIdsGenerator(),
+        )
+    )
+    tracer = trace.get_tracer(__name__)
+
+    if __name__ == "__main__":
+        with tracer.start_as_current_span('my_first_span', kind=SpanKind.SERVER):
+            print('Success!')
+
+
+References
+----------
+
+* `OpenTelemetry Project <https://opentelemetry.io/>`_