From 3e3da9f46803435434156086d6ec5ee75d117cd8 Mon Sep 17 00:00:00 2001 From: ivanarya007 <97018175+ivanarya007@users.noreply.github.com> Date: Tue, 5 Dec 2023 09:26:20 +0530 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 7e1b7289..34a141ee 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,28 @@ + + +# `Cloudstream3 Plugin Repo Template` + +Template for a [Cloudstream3](https://github.com/recloudstream) plugin repo + +**⚠️ Make sure you check "Include all branches" when using this template** + + +## Getting started with writing your first plugin + +This template includes 1 example plugin. + +1. Open the root build.gradle.kts, read the comments and replace all the placeholders +2. Familiarize yourself with the project structure. Most files are commented +3. Build or deploy your first plugin using: + - Windows: `.\gradlew.bat ExampleProvider:make` or `.\gradlew.bat ExampleProvider:deployWithAdb` + - Linux & Mac: `./gradlew ExampleProvider:make` or `./gradlew ExampleProvider:deployWithAdb` + +## Attribution + +This template as well as the gradle plugin and the whole plugin system is **heavily** based on [Aliucord](https://github.com/Aliucord). +*Go use it, it's a great mobile discord client mod!* + +