mirror of
https://github.com/SteamDeckHomebrew/decky-frontend-lib.git
synced 2026-05-24 20:08:54 +02:00
Update README.md
This commit is contained in:
26
README.md
26
README.md
@@ -1 +1,27 @@
|
||||
# Decky Frontend Library
|
||||
|
||||
Library used to develop plugins used for use with [decky-loader](https://github.com/SteamDeckHomebrew/decky-loader).
|
||||
|
||||
## Decky Loader Discord [](https://discord.gg/ZU74G2NJzk)
|
||||
|
||||
Please contact the developers here for questions and support that cannot be addressed via a Github issue.
|
||||
|
||||
## Developers and Contributors
|
||||
|
||||
This library is focused on usage by developers to provide custom React components based on those found in the Steam Deck's React UI.
|
||||
This method allows developers to add UI elements and code without clobbering the existing UI of the deck in order to do so.
|
||||
This library can also theoretically be used to extend existing UI elements of the Steam Deck UI but this has not been tested extensively.
|
||||
|
||||
### Getting Started (Contributors)
|
||||
|
||||
1. Clone the repository to your preferred location
|
||||
2. If you wish to add features such as new UI components, please create a feature branch to PR to the original repo.
|
||||
3. Bug/hotfixes are acceptable on the main branch,
|
||||
|
||||
### Getting Started (Developers)
|
||||
|
||||
If you would like a feature added to decky-frontend-lib, please request it via a Github issue.
|
||||
|
||||
If you want to start making a plugin with decky-frontend-lib, please direct your attention to the [decky-plugin-template](https://github.com/SteamDeckHomebrew/decky-plugin-template) repository.
|
||||
|
||||
This library can be found on [npm](https://www.npmjs.com/package/decky-frontend-lib) and as such you can pull it without a local copy for your project as needed.
|
||||
|
||||
Reference in New Issue
Block a user