aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages/svelte/README.md
diff options
context:
space:
mode:
authorMatthew Strapp <matt@mattstrapp.net>2024-10-30 16:53:20 -0500
committerGitHub <noreply@github.com>2024-10-30 16:53:20 -0500
commitc544dffb148f08518600ea6b7096450e978304ff (patch)
tree14c19442520239cdb8ae387990d1f371c57950c5 /src/packages/svelte/README.md
parentversion bump the gemfile lock too (diff)
downloadlocusts-c544dffb148f08518600ea6b7096450e978304ff.tar
locusts-c544dffb148f08518600ea6b7096450e978304ff.tar.gz
locusts-c544dffb148f08518600ea6b7096450e978304ff.tar.bz2
locusts-c544dffb148f08518600ea6b7096450e978304ff.tar.lz
locusts-c544dffb148f08518600ea6b7096450e978304ff.tar.xz
locusts-c544dffb148f08518600ea6b7096450e978304ff.tar.zst
locusts-c544dffb148f08518600ea6b7096450e978304ff.zip
feat: Svelte (#34)
* feat: Svelte Signed-off-by: Matt Strapp <matt@mattstrapp.net> * oopsie Signed-off-by: Matt Strapp <matt@mattstrapp.net> * add docs Signed-off-by: Matt Strapp <matt@mattstrapp.net> * dev dependency Signed-off-by: Matt Strapp <matt@mattstrapp.net> * Lint Signed-off-by: Matt Strapp <matt@mattstrapp.net> * CI: Check formatting Signed-off-by: Matt Strapp <matt@mattstrapp.net> * Add line ending thingy Signed-off-by: Matt Strapp <matt@mattstrapp.net> * Update prettier and typescript versions in package.json Signed-off-by: Matt Strapp <matt@mattstrapp.net> --------- Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'src/packages/svelte/README.md')
-rw-r--r--src/packages/svelte/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/packages/svelte/README.md b/src/packages/svelte/README.md
new file mode 100644
index 0000000..e638873
--- /dev/null
+++ b/src/packages/svelte/README.md
@@ -0,0 +1,25 @@
+# @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)
+
+## 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.
+
+## Installation
+
+```sh
+npm add -D @locusts/svelte
+```
+
+## Example
+
+```svelte
+<script>
+ import Locusts from '@locusts/svelte';
+</script>
+
+<Locusts />
+```