Update README.md

This commit is contained in:
ivanarya007 2023-12-05 09:25:24 +05:30 committed by GitHub
parent fb73c9eabb
commit 8cbf73d52c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -41,3 +41,28 @@
</div>
# `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!*