aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages/vue
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-10-31 14:07:59 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-10-31 14:07:59 -0500
commit60f863ed1c82fca71f104fe6dff03ce65b6e576a (patch)
treece1b0ec92ebe7ecb85d85a4c5cfb35a14acd55a0 /src/packages/vue
parentfeat: Vue (#37) (diff)
downloadlocusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.gz
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.bz2
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.lz
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.xz
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.zst
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.zip
docs: a lot of them
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'src/packages/vue')
-rw-r--r--src/packages/vue/README.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/src/packages/vue/README.md b/src/packages/vue/README.md
index 33895ab..b4102f0 100644
--- a/src/packages/vue/README.md
+++ b/src/packages/vue/README.md
@@ -1,5 +1,28 @@
-# Vue 3 + TypeScript + Vite
+# @locusts/vue
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml)
+[![NPM Version](https://img.shields.io/npm/v/%40locusts%2Fvue?logo=vuedotjs)](https://www.npmjs.com/package/@locusts/vue)
-Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
+## Description
+
+@locusts/vue is a member of a [series of components](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your website.
+
+Why would you want to do that? I don't know.
+
+## Installation
+
+```bash
+npm install @locusts/vue
+```
+
+## Usage
+
+```vue
+<script setup>
+import { Locusts } from '@locusts/vue';
+</script>
+
+<template>
+ <Locusts />
+</template>
+```