Skip to content
This repository has been archived by the owner on Jul 9, 2024. It is now read-only.

Commit

Permalink
stub docs
Browse files Browse the repository at this point in the history
Notplayingallday383 authored May 13, 2024
1 parent a3d8c13 commit 2c186fe
Showing 3 changed files with 27 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

21 changes: 21 additions & 0 deletions docs/configurations.md
Original file line number Diff line number Diff line change
@@ -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
8 changes: 4 additions & 4 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 2c186fe

Please sign in to comment.