diff --git a/README.md b/README.md index 89408ae..bc7642b 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,38 @@ -# Sigyn +# Sigyn (Ozone): A Limnoria Plugin for Network-Level Spam and Abuse Handling -A Limnoria plugin to handle spam and abuse on a network level. +## Introduction -## Requesting ozone to your channel +Ozone is a Limnoria plugin designed to manage spam and network abuse across multiple channels. It aids in enhancing the security of your network by managing users and keeping the channels free from any sort of spamming or abusive activities. -The best way is to discuss with a staffer, you could also ask for her presence temporary (duration varies), with an `/invite ozone` (reviewed by staff). +## Requesting Ozone to Your Channel -But as invite notification can be missed, feel free to join `#libera-bots` and ask in there. +To request Ozone's presence in your channel, the preferable method is to discuss with a staffer. You could also temporarily request its presence by using the `/invite ozone`, this is reviewed by staff. It's important to note that invite notifications might be missed sometimes. If this is the case, feel free to join `#libera-bots` for assistance. -If opped in your channel you can ask Sigyn to unkline an user, `/msg ozone unkline `, you have a dozen minutes to do so after the kill/kline, it only works if the user was banned due to abuse detected in your channel. +Additionally, once Ozone is opped in your channel, you can ask it to unkline a user using the `/msg ozone unkline ` command. This action can be taken within a dozen minutes following the kill/kline. It’s important to note that it will only work if the user was banned due to abuse detected in your channel. + +## Using the Ozone Plugin with Limnoria + +Using Ozone as a plugin with Limnoria involves the following steps: + +1. First, you need Limnoria. If you haven't installed it yet, you can get it from the [Github](https://github.com/ProgVal/Limnoria) repository. +2. Once you have Limnoria running, you can add the Ozone plugin to your bot using the `!load ozone` command. + +_Note: If the bot doesn't have the plugin, a 'no such plugin' error will be returned._ ## Code of Conduct -We enforce the -[Contributor Covenant, version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html), -which can be summed up as: Be respectful to everyone, and act in a constructive, -professional manner towards everyone. If you feel someone is violating the Code -of Conduct, please PM me (niko) on IRC, or email me at niko@libera.chat +We enforce the ['Contributor Covenant' (version 1.4)](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). In essence, this covenant encourages all participants to be respectful and maintain a professional and constructive attitude towards everyone. If someone is violating the Code of Conduct, please PM 'niko' on IRC, or send an email to niko@libera.chat. + +## Contribution Guidelines + +Refer to the guidelines provided in `CONTRIBUTING.md` file for making contributions to this project. + +Please ensure you follow the Code of Conduct for all your interactions with the project. + +## Troubleshooting + +If you run into issues, check for any errors in your console output. If your issues persist, feel free to log an issue via the 'Issues' tab in the Github project. + +## License + +This project strictly follows the guidelines mentioned in its [LICENSE](https://github.com/Libera-Chat/ozone/blob/master/LICENSE).