diff options
| -rw-r--r-- | README.md | 7 | ||||
| -rw-r--r-- | docs/.NET.md | 4 | ||||
| -rw-r--r-- | docs/BEAM.md | 15 | ||||
| -rw-r--r-- | docs/C.md | 5 | ||||
| -rw-r--r-- | docs/Docker.md | 4 | ||||
| -rw-r--r-- | docs/Go.md | 4 | ||||
| -rw-r--r-- | docs/JVM.md | 12 | ||||
| -rw-r--r-- | docs/JavaScript.md | 7 | ||||
| -rw-r--r-- | docs/Python.md | 5 | ||||
| -rw-r--r-- | docs/Ruby.md | 8 | ||||
| -rw-r--r-- | docs/Rust.md | 5 | ||||
| -rw-r--r-- | locusts.gemspec | 1 | ||||
| -rw-r--r-- | src/packages/locusts/README.md | 9 | ||||
| -rw-r--r-- | src/packages/svelte/README.md | 9 | ||||
| -rw-r--r-- | src/packages/vue/README.md | 29 |
15 files changed, 90 insertions, 34 deletions
@@ -27,6 +27,7 @@ We here at Locusts-R-Us have developed a series of libraries for all sorts of pr [](https://github.com/locusts-r-us/locusts/issues/32) [](https://www.npmjs.com/package/locusts) [](https://www.npmjs.com/package/@locusts/svelte) +[](https://www.npmjs.com/package/@locusts/vue) [](https://www.nuget.org/packages/locusts) [](https://pypi.org/project/locusts-r-us/) @@ -65,7 +66,7 @@ See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information. - [Rust](./docs/Rust.md) - [Python](./docs/Python.md) - [C#/F#](./docs/.NET.md) -- [JavaScript/TypeScript](./docs/JavaScript.md) +- [JavaScript/TypeScript (both Node and Deno)](./docs/JavaScript.md) - [BEAM](./docs/BEAM.md) - [JVM](./docs/JVM.md) - [Ruby](./docs/Ruby.md) @@ -73,7 +74,9 @@ See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information. ### Not a language but still supported - [Docker](./docs/Docker.md) +- [Svelte](./src/packages/svelte/README.md) +- [Vue](./src/packages/vue/README.md) ## License -Every locust library in this repository is licensed under the [BSD 0 Clause License](./LICENSE). +Every library, component, container, etc. in this repository is licensed under the [BSD 0 Clause License](./LICENSE). diff --git a/docs/.NET.md b/docs/.NET.md index e8a2c29..206b521 100644 --- a/docs/.NET.md +++ b/docs/.NET.md @@ -5,7 +5,7 @@ ## Description -Locusts is a library that provides a way to introduce locusts into your code. +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. Why would you want to do that? I don't know. @@ -27,4 +27,4 @@ Locusts.IntroduceLocusts(); ## License This project is licensed under the BSD Zero Clause License. See the -[LICENSE](../LICENSE) file for details. +[LICENSE](https://github.com/locusts-r-us/locusts/blob/master/LICENSE) file for details. diff --git a/docs/BEAM.md b/docs/BEAM.md index abdce6a..de0852d 100644 --- a/docs/BEAM.md +++ b/docs/BEAM.md @@ -1,10 +1,14 @@ -# Locusts +# :locusts [](https://github.com/locusts-r-us/locusts/actions/workflows/beam.yml)  - +[](https://hexdocs.pm/locusts) -**TODO: Add description** +## Description + +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. + +Why would you want to do that? I don't know. ## Installation @@ -23,3 +27,8 @@ Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) and published on [HexDocs](https://hexdocs.pm). Once published, the docs can be found at <https://hexdocs.pm/locusts>. + +## License + +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. @@ -4,10 +4,11 @@ ## Description -liboCusts is a library that provides a way to introduce locusts into your code. +liboCusts is a member of a [series of libraries](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your codebase. Why would you want to do that? I don't know. + ## Example ```c @@ -49,4 +50,4 @@ make ## License This project is licensed under the BSD Zero Clause License. See the -[LICENSE](../LICENSE) file for details. +[LICENSE](https://github.com/locusts-r-us/locusts/blob/master/LICENSE) file for details. diff --git a/docs/Docker.md b/docs/Docker.md index 7e6ab52..62d479c 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -13,3 +13,7 @@ docker run --rm ghcr.io/locusts-r-us/locusts:master That's it. There are locusts now in your computer. What those locusts do is up to the reader. + +## License + +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. @@ -5,7 +5,7 @@ ## Description -Locusts is a library that provides a way to introduce locusts into your code. +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. Why would you want to do that? I don't know. @@ -31,4 +31,4 @@ func main() { ## License This project is licensed under the BSD Zero Clause License. See the -[LICENSE](../LICENSE) file for details. +[LICENSE](https://github.com/locusts-r-us/locusts/blob/master/LICENSE) file for details. diff --git a/docs/JVM.md b/docs/JVM.md index a0d4cda..48dffa3 100644 --- a/docs/JVM.md +++ b/docs/JVM.md @@ -1,5 +1,13 @@ -# locusts +# io.github.locusts-r-us.locusts [](https://github.com/locusts-r-us/locusts/actions/workflows/jvm.yml) -TODO: Fill out this README.md with information about the JVM library. +io.github.locusts-r-us.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 + +TODO + +## License + +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/docs/JavaScript.md b/docs/JavaScript.md index f8a6687..3f9d787 100644 --- a/docs/JavaScript.md +++ b/docs/JavaScript.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 @@ -27,3 +26,7 @@ function main() { // Locusts are now in your codebase! } ``` + +## License + +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/docs/Python.md b/docs/Python.md index 51d4bd6..98a2397 100644 --- a/docs/Python.md +++ b/docs/Python.md @@ -5,8 +5,7 @@ ## Description -locusts-r-us is a library that provides a way to introduce locusts into your -code. +locusts-r-us is a member of a [series of libraries](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your codebase. Why would you want to do that? I don't know. @@ -32,4 +31,4 @@ if __name__ == "__main__": ## License This project is licensed under the BSD Zero Clause License. See the -[LICENSE](../LICENSE) file for details. +[LICENSE](https://github.com/locusts-r-us/locusts/blob/master/LICENSE) file for details. diff --git a/docs/Ruby.md b/docs/Ruby.md index c79057a..c6012a4 100644 --- a/docs/Ruby.md +++ b/docs/Ruby.md @@ -5,7 +5,9 @@ ## Description -locusts is a library that provides a way to introduce locusts into your code. +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. + +Why would you want to do that? I don't know. ## Installation @@ -23,3 +25,7 @@ def main # Locusts are now in your codebase! end ``` + +## License + +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/docs/Rust.md b/docs/Rust.md index c42257a..d2852dd 100644 --- a/docs/Rust.md +++ b/docs/Rust.md @@ -6,7 +6,7 @@ ## Description -locusts is a library that provides a way to introduce locusts into your code. +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. Why would you want to do that? I don't know. @@ -38,5 +38,4 @@ fn main() { ## License -This project is licensed under the BSD Zero Clause License. See the -[LICENSE](../LICENSE) file for details. +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/locusts.gemspec b/locusts.gemspec index 75b0e6b..fd11e70 100644 --- a/locusts.gemspec +++ b/locusts.gemspec @@ -11,6 +11,7 @@ Gem::Specification.new do |spec| spec.homepage = "https://github.com/locusts-r-us/locusts" spec.required_ruby_version = ">= 1.6.7" spec.license = "0BSD" + spec.extra_rdoc_files = ["docs/Ruby.md"] # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'" 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 [](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml) -[](https://www.npmjs.com/package/locusts) +[](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. +[](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml) +[](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> +``` |