@frollo/frollo-web-ui 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,30 @@
1
+ ## Frollo Web UI
2
+
3
+ ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@frollo/frollo-web-ui) [![npm](https://img.shields.io/npm/v/@frollo/frollo-web-ui)](https://www.npmjs.com/package/@frollo/frollo-web-ui/v/latest)
4
+
5
+ ### Usage
6
+
7
+ #### Installation
8
+ ```bash
9
+ npm i @frollo/frollo-web-ui
10
+ or
11
+ yarn add @frollo/frollo-web-ui
12
+ ```
13
+
14
+ #### Import entire library globally
15
+ ```ts
16
+ import { createApp } from 'vue'
17
+ import App from './App.vue'
18
+ import FrolloWebUI from '@frollo/frollo-web-ui';
19
+
20
+ const app = createApp(App)
21
+ app.use(FrolloWebUI)
22
+ app.mount('#app')
23
+ ```
24
+
25
+ #### Import components from the esm folder to enable tree-shaking
26
+ ```ts
27
+ import { FwCard } from '@frollo/frollo-web-ui/esm';
28
+ ```
29
+
30
+ Note: For local development please refer to the [general development readme](https://github.com/frollous/frollo-web-ui/blob/develop/development.md).