aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages/svelte/README.md
blob: e63887384006d874b1b7b4132f49d85b05a62655 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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 />
```