publish to npm

Author: yaacov

README.md

@@ -1,4 +1,34 @@
-# kubevirt-ui-components
+[![NPM Version](https://img.shields.io/npm/v/gm.svg?style=flat)](https://www.npmjs.org/package/@kubevirt-ui/components)
+[![codecov](https://codecov.io/gh/kubevirt-ui/kubevirt-ui-components/branch/main/graph/badge.svg?token=wkLwgaN6YD)](https://codecov.io/gh/kubevirt-ui/kubevirt-ui-components)
+[![DeepSource](https://deepsource.io/gh/kubevirt-ui/kubevirt-ui-components.svg/?label=active+issues&show_trend=true&token=eMPSTlO760qY3rcrQ7I5rK5D)](https://deepsource.io/gh/kubevirt-ui/kubevirt-ui-components/?ref=repository-badge)
+
+# @kubevirt-ui/components
+
 React Component Library for Kubevirt UI
 
-https://kubevirt-ui.github.io/kubevirt-ui-components/
+[See the documentaion](https://kubevirt-ui.github.io/kubevirt-ui-components/)
+
+## Add to your project
+
+```bash
+yarn add @kubevirt-ui/components
+```
+
+## Scope
+
+Kubevirt UI compoents is a curated list of stable and documented components used by Kubevirt UI aplications and libraries.
+
+## When should I contribute my components to this repository?
+
+When a componenet used by an application is stable it can be published in this components repository so public users could:
+
+- Use the components for exiting new applications
+- Study how the component works
+- Redistribute the component as they are
+- Modified and create better components based on the components in this repository
+
+## How to document my component when contributing to this repository?
+
+Before moving a component to this repo make sure the code is [documented](https://tsdoc.org/) with descriptions and
+examples in a [markdown](https://www.markdownguide.org/) doc as needed to help users who are not familiar with the application
+and context understand what is the purpose of the component and how to use it.

package.json

@@ -1,15 +1,12 @@
 {
-  "name": "kubevirt-ui-components",
+  "name": "@kubevirt-ui/components",
   "version": "0.0.2",
   "description": "React Component Library for Kubevirt UI",
   "repository": {
     "type": "git",
     "url": "https://github.com/kubevirt-ui/kubevirt-ui-components.git"
   },
-  "private": false,
-  "publishConfig": {
-    "registry": "https://npm.pkg.github.com"
-  },
+  "author": "Yaacov Zamir <[email protected]>",
   "scripts": {
     "clean": "rm -rf dist",
     "build": "rollup -c",