diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.NET.md | 9 | ||||
| -rw-r--r-- | docs/BEAM.md | 34 | ||||
| -rw-r--r-- | docs/C.md | 7 | ||||
| -rw-r--r-- | docs/Docker.md | 13 | ||||
| -rw-r--r-- | docs/Go.md | 8 | ||||
| -rw-r--r-- | docs/JVM.md | 13 | ||||
| -rw-r--r-- | docs/JavaScript.md | 34 | ||||
| -rw-r--r-- | docs/Python.md | 8 | ||||
| -rw-r--r-- | docs/Ruby.md | 31 | ||||
| -rw-r--r-- | docs/Rust.md | 8 |
10 files changed, 142 insertions, 23 deletions
diff --git a/docs/.NET.md b/docs/.NET.md index 28ce4b8..206b521 100644 --- a/docs/.NET.md +++ b/docs/.NET.md @@ -1,11 +1,11 @@ # Locusts -[](https://github.com/locusts-r-us/locusts/actions/workflows/dotnet.yml) +[](https://github.com/locusts-r-us/locusts/actions/workflows/dotnet.yml)  ## 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. @@ -20,10 +20,11 @@ dotnet add package Locusts ```cs using Locusts; -Locusts.Introduce(); +Locusts.IntroduceLocusts(); // Locusts are now in your codebase! ``` ## 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/docs/BEAM.md b/docs/BEAM.md new file mode 100644 index 0000000..de0852d --- /dev/null +++ b/docs/BEAM.md @@ -0,0 +1,34 @@ +# :locusts + +[](https://github.com/locusts-r-us/locusts/actions/workflows/beam.yml) + +[](https://hexdocs.pm/locusts) + +## 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 + +If [available in Hex](https://hex.pm/docs/publish), the package can be installed +by adding `locusts` to your list of dependencies in `mix.exs`: + +```elixir +def deps do + [ + {:locusts, ">= 0.0.0"} + ] +end +``` + +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. @@ -1,10 +1,10 @@ # liboCusts -[](https://github.com/locusts-r-us/locusts/actions/workflows/c.yml) +[](https://github.com/locusts-r-us/locusts/actions/workflows/c.yml) ## 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. @@ -48,4 +48,5 @@ make ## 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/docs/Docker.md b/docs/Docker.md index 10019ff..62d479c 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -1,14 +1,19 @@ # Locusts -[](https://github.com/locusts-r-us/locusts/actions/workflows/docker.yml) +[](https://github.com/locusts-r-us/locusts/actions/workflows/docker.yml) A docker container containing locusts also exist. -If you would like to add locusts to your company's servers, you can use the following command: +If you would like to add locusts to your company's servers, you can use the +following command: ```bash 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. +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. @@ -1,10 +1,11 @@ # Locusts -[](https://github.com/locusts-r-us/locusts/actions/workflows/go.yml) +[](https://github.com/locusts-r-us/locusts/actions/workflows/go.yml) +[](https://pkg.go.dev/github.com/locusts-r-us/locusts) ## 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. @@ -29,4 +30,5 @@ func 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/docs/JVM.md b/docs/JVM.md new file mode 100644 index 0000000..48dffa3 --- /dev/null +++ b/docs/JVM.md @@ -0,0 +1,13 @@ +# io.github.locusts-r-us.locusts + +[](https://github.com/locusts-r-us/locusts/actions/workflows/jvm.yml) + +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 52e116b..3f9d787 100644 --- a/docs/JavaScript.md +++ b/docs/JavaScript.md @@ -1,4 +1,32 @@ -# TODO +# Locusts -[](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml) - +[](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml) +[](https://www.npmjs.com/package/locusts) + +[](https://github.com/locusts-r-us/locusts/actions/workflows/deno.yml) +[](https://jsr.io/@locusts-r-us/locusts) + +## 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. + +## Installation + +```sh +npm add locusts +``` + +## Example + +```javascript +import introduceLocusts from "locusts"; + +function main() { + introduceLocusts(); + // 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 3656ac7..98a2397 100644 --- a/docs/Python.md +++ b/docs/Python.md @@ -1,10 +1,11 @@ # locusts-r-us -[](https://github.com/locusts-r-us/locusts/actions/workflows/python.yml) +[](https://github.com/locusts-r-us/locusts/actions/workflows/python.yml) + ## 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. @@ -29,4 +30,5 @@ if __name__ == "__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/docs/Ruby.md b/docs/Ruby.md new file mode 100644 index 0000000..c6012a4 --- /dev/null +++ b/docs/Ruby.md @@ -0,0 +1,31 @@ +# locusts + +[](https://github.com/locusts-r-us/locusts/actions/workflows/main.yml) + + +## 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 + +```sh +bundle add locusts +``` + +## Example + +```ruby +require 'locusts' + +def main + locusts.introduceLocusts + # 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 977b404..d2852dd 100644 --- a/docs/Rust.md +++ b/docs/Rust.md @@ -1,10 +1,12 @@ # locusts -[](https://github.com/locusts-r-us/locusts/actions/workflows/rust.yml) +[](https://github.com/locusts-r-us/locusts/actions/workflows/rust.yml) +[](https://crates.io/crates/locusts) +[](https://docs.rs/locusts) ## 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. @@ -36,4 +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. |