From 2c586585ec5d1be55ebb235613602f6ea3381e9d Mon Sep 17 00:00:00 2001 From: WerWolv Date: Sun, 3 Apr 2022 20:50:23 +0200 Subject: [PATCH] Added proper readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a3f470..a298fd3 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ -# Plugin-Template \ No newline at end of file +# Plugin-Template + +This is the template plugin for developing plugins for the [SteamOS Plugin Loader](https://github.com/SteamDeckHomebrew/PluginLoader). + +## Usage + +1. Click on the green `Use this template` button to create a new repository for your plugin +2. Rename the `plugin_template.py` file to something unique +3. Add your code to the plugin python file +4. To use it, simply copy the file to the `/home/deck/homebrew/plugins` folder on your Steam Deck + +## License + +This Template Project is under The Unlicense. You may license your own plugin under whatever license you prefer.