Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TrainDoctor authored Feb 16, 2023
1 parent e91ba9e commit e49fb07
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@

**This repository exists solely for developers to submit plugins**

Use the built-in [Plugin Store](https://deckbrew.xyz/en/user-guide/plugin-store) to download and install plugins.
Use the built-in [Plugin Store](https://wiki.deckbrew.xyz/en/user-guide/plugin-store) to download and install plugins.

## Submit your plugin

**For plugin developers submitting their plugin for the first time, please consult the wiki page on [submitting your plugin](https://wiki.deckbrew.xyz/en/plugin-dev/submitting-plugins).**
This README provides a good resource for the simple git related and a few other items, but the wiki has the rest of the information you'll need.

To submit a plugin to Decky's plugin store, open a pull request adding your plugin as a submodule (take a look at [#8](https://github.com/SteamDeckHomebrew/decky-plugin-database/pull/8) for example).
Don't forget to bump your version number in package.json.
If you are not sure how to make a submodule, please reference the [git docs](https://git-scm.com/book/en/v2/Git-Tools-Submodules) on submodules.
Expand All @@ -13,5 +17,6 @@ Once you have your submodule added, in order to update it,
change directories to ``plugins/your-plugin`` and run ``git submodule update --init``.
This should update your plugin to the latest version.

Please make sure your plugin is compliant with the pull-request template's steps.
Please make sure your plugin is compliant with the pull-request template's steps.
Plugins found to be out of compliance will not be accepted.
If your plugin does not meet any of the criteria for utilizing a custom backend, then it only requires testing against Stable and Beta SteamOS Update Channels.

0 comments on commit e49fb07

Please sign in to comment.