docs: add readme (#38)

This commit is contained in:
2022-09-14 18:56:40 +02:00
committed by GitHub
parent a054a6ffba
commit 5bd20cf706

View File

@@ -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.