From eab237db546a21105a1adfcd31ff91d952f2909c Mon Sep 17 00:00:00 2001 From: V Date: Thu, 20 Apr 2023 04:36:10 +0200 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index d82b294..c8f0caf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # Vencord Plugin Template This is not usable for now. Gotta finish https://github.com/Vendicated/Vencord/pull/951 first + +## Prerequisites + +Install git, node and pnpm + +## QuickStart + +- Click "Use this template" (not enabled for now cause unfinished) +- Clone your repo via `git clone yourrepo` and cd into it +- (Optional) Edit config.json to add your Vencord location. This enables auto deploy +- Install dependencies: `pnpm i` +- You can now build the example plugin via `pnpm build` + +## Next Steps + +Edit the example plugin to do what you want it to do + +To create more plugins, just create a new folder in plugins/ + +To publish finished plugins [TODO]