From 2c186fe063fbb9962f2a44bbc1cbd63b90aff0b6 Mon Sep 17 00:00:00 2001 From: John <72810050+Notplayingallday383@users.noreply.github.com> Date: Sun, 12 May 2024 21:39:04 -0400 Subject: [PATCH] stub docs --- README.md | 4 ++-- docs/configurations.md | 21 +++++++++++++++++++++ docs/readme.md | 8 ++++---- 3 files changed, 27 insertions(+), 6 deletions(-) create mode 100644 docs/configurations.md diff --git a/README.md b/README.md index 67c7426..9a36736 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The better made open source version of Sodiums Plugin Injector ## Usage -> [!NOTE] If your a skid fuck off this is not for you. This is for developers +> [!IMPORTANT] This is in very early development, please do not make github issues that are not detailed or that arent helpful. To add to an existing React, Dreamland, Next, etc project you can do it via downloading the npm package and adding it to your site via backend or using something like vite. @@ -16,7 +16,7 @@ if your statically hosting this simply build this repository and add it to your ### Setting up Plugins -Plugins should be saved to a localstorage item or you can modify the configuration to use something like `FilerFS` to access the plugins. Refer to our documentation to learn how to configure your config file. +Plugins should be saved to a localstorage item or you can modify the configuration to use something like `FilerFS` to access the plugins. Refer to our [documentation](/docs/readme.md) to learn how to configure your config file. ### Credits diff --git a/docs/configurations.md b/docs/configurations.md new file mode 100644 index 0000000..ac92795 --- /dev/null +++ b/docs/configurations.md @@ -0,0 +1,21 @@ +# Configuring Injectify + +Injectify offers many configuration options, I will break it down more in debpt bellow but first make sure that **IF** your initializing if from the backend, you create the config file first to override the defualt one. Example if injectify in your backend is configured to a `/injectify` than in your public folder or wherever your frontend is create a folder called `injectify` and put a file in there called `config.js` then configure it as you like using the tools bellow. + +## Defining the config + +If you were initializing it from the backend like above and dont know what to first put in the file heres what you need to put first. + +```js +self.__injectify$cfg = { + // LEAVE THIS BLANK FOR NOW YOU WILL INSERT OPTIONS BELOW AS YOU GO +} +``` + +### Options + +#### UseProxy + +- Description: This enables the use of encoding and loading the injected scripts using UV with XOR (**NOTE** This will soon be depreccated this is just here for backwards compatability with older versions of sites like sodium) + +#### TODO diff --git a/docs/readme.md b/docs/readme.md index b5e6ea7..2eba984 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -4,7 +4,7 @@ Welcome to the Injectify Docs. These docs are also avalible on the [z1g Docs Sit ## Directory -- Configuring Injectify -- Building Injectify -- How to use Injectify -- FSTypes +- [Configuring Injectify](./configurations.md) +- [Building Injectify](./building.md) +- [How to use Injectify](./howto.md) +- [FSTypes](./fstypes.md)