aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-10-31 14:07:59 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-10-31 14:07:59 -0500
commit60f863ed1c82fca71f104fe6dff03ce65b6e576a (patch)
treece1b0ec92ebe7ecb85d85a4c5cfb35a14acd55a0 /docs
parentfeat: Vue (#37) (diff)
downloadlocusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.gz
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.bz2
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.lz
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.xz
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.tar.zst
locusts-60f863ed1c82fca71f104fe6dff03ce65b6e576a.zip
docs: a lot of them
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/.NET.md4
-rw-r--r--docs/BEAM.md15
-rw-r--r--docs/C.md5
-rw-r--r--docs/Docker.md4
-rw-r--r--docs/Go.md4
-rw-r--r--docs/JVM.md12
-rw-r--r--docs/JavaScript.md7
-rw-r--r--docs/Python.md5
-rw-r--r--docs/Ruby.md8
-rw-r--r--docs/Rust.md5
10 files changed, 49 insertions, 20 deletions
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
[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/beam.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/beam.yml)
![Hex.pm Version](https://img.shields.io/hexpm/v/locusts?logo=erlang)
-![Docs](https://img.shields.io/badge/docs-hexdocs.pm-blue?logo=elixir)
+[![Docs](https://img.shields.io/badge/docs-hexdocs.pm-blue?logo=elixir)](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.
diff --git a/docs/C.md b/docs/C.md
index e3ae830..01a5150 100644
--- a/docs/C.md
+++ b/docs/C.md
@@ -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.
diff --git a/docs/Go.md b/docs/Go.md
index f0a9925..3c6fbc3 100644
--- a/docs/Go.md
+++ b/docs/Go.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.
@@ -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
[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/jvm.yml/badge.svg)](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.