kritzel-vue 0.0.21 → 0.0.37

package/README.md

@@ -1,11 +1,30 @@
-# `vue`
+# Setup
 
-> TODO: description
+Install the kritzel-vue package.
+```
+npm i kritzel-vue
+```
+
+Import the ComponentLibrary register it as a plugin.
+```typescript
+import { createApp } from 'vue'
+import App from './App.vue'
+import { ComponentLibrary } from 'kritzel-vue'
 
-## Usage
+createApp(App).use(ComponentLibrary).mount('#app')
 
 ```
-const vue = require('vue');
 
-// TODO: DEMONSTRATE API
+Add MyList to your imports to use it in your component template.
+```typescript
+<script setup lang="ts">
+import { MyList } from 'kritzel-vue';
+</script>
+
+<template>
+  <MyList></MyList>
+</template>
+
+<style scoped>
+</style>
 ```

package/dist/plugin.js

@@ -1,4 +1,4 @@
-import { defineCustomElements } from '@kritzel/stencil/loader';
+import { defineCustomElements } from 'kritzel-stencil/loader';
 export const ComponentLibrary = {
     async install() {
         defineCustomElements();

package/package.json

@@ -1,8 +1,6 @@
 {
   "name": "kritzel-vue",
-  "version": "0.0.21",
-  "description": "> TODO: description",
-  "author": "kasual1 <seifertluk11@gmail.com>",
+  "version": "0.0.37",
   "homepage": "https://gitlab.com/kasual1/kritzel#readme",
   "license": "ISC",
   "main": "dist/index.js",
@@ -33,7 +31,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@stencil/vue-output-target": "0.8.9",
-    "@kritzel/stencil": "file:../stencil"
+    "@stencil/vue-output-target": "0.8.9"
+  },
+  "peerDependencies": {
+    "kritzel-stencil": "^0.0.37"
   }
 }