浏览代码

Update grafana/ui readme

Dominik Prokop 6 年之前
父节点
当前提交
10916d9192
共有 1 个文件被更改,包括 12 次插入2 次删除
  1. 12 2
      packages/grafana-ui/README.md

+ 12 - 2
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`