Add installation instructions

This commit is contained in:
René Preuß
2022-10-30 14:20:57 +01:00
parent 473c69869d
commit 11570c9832

View File

@@ -4,6 +4,22 @@
The main goal of this package is to provide a clean & simple usage of common components in bitinflow brand. The main goal of this package is to provide a clean & simple usage of common components in bitinflow brand.
## Installation using GitHub
Since this package is not released on npm (yet), we need to add `@bitinflow/ui` as dependency to our `package.json`
file manually:
```
"@bitinflow/ui": "github:bitinflow/ui#main",
```
Install/Update the dependency:
```bash
npm install @bitinflow/ui
```
## Example Skeleton ## Example Skeleton
This example skeleton provides the default ui experience for dashboards, featuring first-, second- & This example skeleton provides the default ui experience for dashboards, featuring first-, second- &