diff options
Diffstat (limited to 'docs/Ruby.md')
-rw-r--r-- | docs/Ruby.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/Ruby.md b/docs/Ruby.md new file mode 100644 index 0000000..c79057a --- /dev/null +++ b/docs/Ruby.md @@ -0,0 +1,25 @@ +# 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 library that provides a way to introduce locusts into your code. + +## Installation + +```sh +bundle add locusts +``` + +## Example + +```ruby +require 'locusts' + +def main + locusts.introduceLocusts + # Locusts are now in your codebase! +end +``` |