aboutsummaryrefslogtreecommitdiffstats
path: root/src
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
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 '')
-rw-r--r--src/packages/locusts/README.md9
-rw-r--r--src/packages/svelte/README.md9
-rw-r--r--src/packages/vue/README.md29
3 files changed, 35 insertions, 12 deletions
diff --git a/src/packages/locusts/README.md b/src/packages/locusts/README.md
index 0b95dcd..3f9d787 100644
--- a/src/packages/locusts/README.md
+++ b/src/packages/locusts/README.md
@@ -8,8 +8,7 @@
## Description
-Locusts is a series of libraries that allows you to introduce locusts into your
-codebase. Why would you want to do that? I don't know.
+locusts is a member of a [series of libraries](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your codebase.
## Installation
@@ -19,7 +18,7 @@ npm add locusts
## Example
-```typescript
+```javascript
import introduceLocusts from "locusts";
function main() {
@@ -28,6 +27,6 @@ function main() {
}
```
-## JavaScript Frameworks
+## License
-- [Svelte](../svelte/README.md)
+This project is licensed under the BSD Zero Clause License. See the [LICENSE](https://github.com/locusts-r-us/locusts/blob/master/LICENSE) file for details.
diff --git a/src/packages/svelte/README.md b/src/packages/svelte/README.md
index 5fee47e..809a080 100644
--- a/src/packages/svelte/README.md
+++ b/src/packages/svelte/README.md
@@ -1,12 +1,13 @@
# @locusts/svelte
[![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/locusts?logo=svelte&label=NPM%20Package)](https://www.npmjs.com/package/locusts)
+[![NPM Version](https://img.shields.io/npm/v/%40locusts%2Fsvelte?logo=svelte)](https://www.npmjs.com/package/@locusts/svelte)
## Description
-Locusts is a series of libraries that allows you to introduce locusts into your
-codebase. Why would you want to do that? I don't know.
+@locusts/svelte 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
@@ -18,7 +19,7 @@ npm add -D @locusts/svelte
```svelte
<script>
- import Locusts from '@locusts/svelte';
+ import Locusts from '@locusts/svelte';
</script>
<Locusts />
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>
+```