From 10916d9192f5e702a817dee4bcdea1598d5ab80c Mon Sep 17 00:00:00 2001 From: Dominik Prokop Date: Thu, 21 Feb 2019 17:45:52 +0100 Subject: [PATCH] Update grafana/ui readme --- packages/grafana-ui/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/packages/grafana-ui/README.md b/packages/grafana-ui/README.md index 1413965f7da..b62d19d2432 100644 --- a/packages/grafana-ui/README.md +++ b/packages/grafana-ui/README.md @@ -1,3 +1,13 @@ -# Grafana (WIP) shared component library +# Grafana UI components library -Used by internal & external plugins. +@grafana/ui is a collection of components used by [Grafana](https://github.com/grafana/grafana) + +Our goal is to deliver Grafana's common UI elements for plugins developers and contributors. + +See [package source](https://github.com/grafana/grafana/tree/master/packages/grafana-ui) for more details. + +## Installation + +`yarn add @grafana/ui` + +`npm install @grafana/ui`