From 60f863ed1c82fca71f104fe6dff03ce65b6e576a Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Thu, 31 Oct 2024 14:07:59 -0500 Subject: docs: a lot of them Signed-off-by: Matt Strapp --- docs/BEAM.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'docs/BEAM.md') 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 . + +## 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. -- cgit v1.2.3