summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWerWolv <werwolv98@gmail.com>2022-03-31 15:48:20 +0200
committerGitHub <noreply@github.com>2022-03-31 15:48:20 +0200
commit9bebfdf4fca0aede3eaae2fefe59e55c5d1087f9 (patch)
tree47ccdcea9c5ab0254ee0f296094766f8761cebf3
parent4c5ca4e567480d1edf39e5b448bd4f93c1c414c5 (diff)
downloaddecky-loader-9bebfdf4fca0aede3eaae2fefe59e55c5d1087f9.tar.gz
decky-loader-9bebfdf4fca0aede3eaae2fefe59e55c5d1087f9.zip
git: Added proper readme
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index 691401de..71eb37c7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-SteamOS-Plugin-Manager
+# SteamOS Plugin Manager
+
+![steamuserimages-a akamaihd](https://user-images.githubusercontent.com/10835354/161068262-ca723dc5-6795-417a-80f6-d8c1f9d03e93.jpg)
+
+## Installation
+- Go into the Steam Deck Settings
+- Under System -> System Settings toggle `Enable Developer Mode`
+- Scroll the sidebar all the way down and click on `Developer`
+- Under Miscellaneous, enable `CEF Remote Debugging`
+- Place the executable under `~/homebrew/services/plugin_manager`. Do not change the name of the file.
+- Place the plugin_manager.service file under `/etc/systemd/system`
+- Open a Terminal and type `sudo systemctl --now enable plugin_manager`
+
+### Install Plugins
+- Simply copy the plugin's .js file into `~/homebrew/services/plugin_manager/plugins`
+
+## Features
+- Clean injecting and loading of one or more plugins
+- Persistent. It doesn't need to be reinstalled after every system update
+
+## Credit
+
+The original idea for the concept is based on the work of [marios8543's steamdeck-ui-inject](https://github.com/marios8543/steamdeck-ui-inject) project.