From 5bd20cf706581bde3c052817db0f0da14ccc3f13 Mon Sep 17 00:00:00 2001 From: SrIzan10 <66965250+SrIzan10@users.noreply.github.com> Date: Wed, 14 Sep 2022 18:56:40 +0200 Subject: [PATCH] docs: add readme (#38) --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 802ac1f..9aee900 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -## TODO +[![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re) ![discord](https://img.shields.io/discord/889026545715400705) ![reposize](https://img.shields.io/github/languages/code-size/sern-handler/awesome-plugins?label=repo%20size) ![forks](https://img.shields.io/github/forks/sern-handler/awesome-plugins?style=social) ![stars](https://img.shields.io/github/stars/sern-handler/awesome-plugins?style=social) +# sern Plugins + +An awesome list of plugins made by the awesome community, for the awesome community who use the sern framework to develop their Discord Bots. + +## How to install + +As easy as running `sern plugins` with the [CLI](https://github.com/sern-handler/cli). Make sure you have a `sern.config.json` file at the root of your project. + +You can also install them by downloading the file into your project. + +Then, read the comments of the plugin file to know how to use them or run `/plugin` on the discord server + +## Contributing + +Create your plugin by reading the docs, then open a PR. +Code it in TypeScript, and a GitHub Action will convert the plugin to JavaScript automatically when merged.