@evercam/ui 1.0.0-safe-publish-commit-044e0e4ef → 2.0.0-preview-ui-vue3-4a1acb28e

package/README.md

@@ -1 +1,74 @@
-test
+## Evercam UI
+
+### Description
+
+Components libray for the [Evercam](https://evercam.io) frontends.
+
+### Installation
+
+1- Install the package
+
+`yarn add @evercam/ui`
+
+2- Use the components in a Vue app by either:
+
+- Installing the library globally as a Vue plugin:
+
+```javascript
+import Vue from "vue"
+import EvercamUI from "@evercam/ui"
+
+Vue.use(EvercamUI)
+```
+
+- Or importing components individually:
+
+```vue
+<template>
+  <EBadge text="Hello world" color="success" />
+</template>
+
+<script>
+import { EBadge } from "@evercam/ui"
+
+export default {
+  components: {
+    EBadge,
+  },
+}
+</script>
+```
+
+
+### Dev mode
+
+You can preview the components and their stories by running the [Histoire](https://histoire.dev) sever:
+
+`yarn story:dev`
+
+### Writing stories (example files)
+
+Story/example files (`.example.vue` under `docs/examples/`) must use plain JavaScript — **do not use TypeScript** in these files.
+
+The vue-styleguidist internal compiler (`vue-inbrowser-compiler`) uses an acorn-based parser that does not support TypeScript syntax. Using `<script lang="ts">`, type annotations, or `Vue.extend()` in example files will break the story build (`yarn story:build`).
+
+```vue
+<!-- ✅ Correct -->
+<script>
+export default {
+  name: "MyComponentExample",
+  data() {
+    return { value: "" }
+  },
+}
+</script>
+
+<!-- ❌ Wrong – breaks the build -->
+<script lang="ts">
+import Vue from "vue"
+export default Vue.extend({
+  name: "MyComponentExample",
+})
+</script>
+```
+