aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages/svelte/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/packages/svelte/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/packages/svelte/README.md b/src/packages/svelte/README.md
new file mode 100644
index 0000000..47901b3
--- /dev/null
+++ b/src/packages/svelte/README.md
@@ -0,0 +1,26 @@
+# @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/%40locusts%2Fsvelte?logo=svelte)](https://www.npmjs.com/package/@locusts/svelte)
+
+## Description
+
+@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
+
+```sh
+npm add -D @locusts/svelte
+```
+
+## Example
+
+```svelte
+<script>
+ import Locusts from '@locusts/svelte';
+</script>
+
+<Locusts />
+```