aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Ruby.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Ruby.md')
-rw-r--r--docs/Ruby.md31
1 files changed, 31 insertions, 0 deletions
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
+
+[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/main.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/main.yml)
+![Gem Version](https://img.shields.io/gem/v/locusts?logo=ruby)
+
+## 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.