From 60f863ed1c82fca71f104fe6dff03ce65b6e576a Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Thu, 31 Oct 2024 14:07:59 -0500 Subject: docs: a lot of them Signed-off-by: Matt Strapp --- src/packages/locusts/README.md | 9 ++++----- src/packages/svelte/README.md | 9 +++++---- src/packages/vue/README.md | 29 ++++++++++++++++++++++++++--- 3 files changed, 35 insertions(+), 12 deletions(-) (limited to 'src/packages') 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 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 ` + + +``` -- cgit v1.2.3