WIP: add README.md

elastic · Sep 1, 2020 · 11e34ab · 11e34ab
1 parent 2b60b1a
commit 11e34ab
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/x-pack/plugins/infra/public/components/log_stream/README.md b/x-pack/plugins/infra/public/components/log_stream/README.md
@@ -0,0 +1,10 @@
+# Shared `<LogStream />`
+
+Short description of the thing
+
+## Prerequisites
+
+To use the component, there are several things you need to ensure in your plugin:
+
+- In your `kibana.json` plugin, you need to either add `"requiredBundles": ["infra"]` or `"requiredPlugins": ["infra"]`.
+- Your plugin needs to be wrapped with a [`kibana-react` provider](https://github.com/elastic/kibana/blob/b2d0aa7b7fae1c89c8f9e8854ae73e71be64e765/src/plugins/kibana_react/README.md#L45).