Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nebelung-Dev committed Mar 16, 2023
1 parent e7e8f38 commit 20d290c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
- [x] Obfuscate more text

### Upcoming
- [x] Update docs
- [ ] Add a blocklist option
- [ ] Reset all settings
- [ ] Export/import settings
Expand Down
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,36 @@ Run `npm run dev` to run the app in development mode.
Click a button at the top of this page and follow the directions for an easy way to host Metallic.

## Configuration

### Bare Servers
File: [/src/consts.js](https://github.com/Metallic-Web/Metallic/blob/main/src/consts.js)

`const obfuscation = true | false;` - Choose to obfuscate text

### Bare Server
`const obfuscation = true | false;` - Obfuscate text
File: [/src/consts.js](https://github.com/Metallic-Web/Metallic/blob/main/src/consts.js)

`const bareServerURL = new URL(url);` - Main bare server and Stomp bare server


File: [/public/uv/uv.config.js](https://github.com/Metallic-Web/Metallic/blob/main/public/uv/uv.config.js)

`bare: url,` - Ultraviolet bare server


File: [/public/dip/dip.config.js](https://github.com/Metallic-Web/Metallic/blob/main/public/dip/dip.config.js)

`bare: {`
` version: 1 | 2,` - DIP bare version
` path: url,` - DIP bare server
`}`


File: [/public/aero/config.js](https://github.com/Metallic-Web/Metallic/blob/main/public/aero/config.js)

`const backends = [url];` - Aero bare server


## Changelog
View the changelog/roadmap [here](https://github.com/Metallic-Web/Metallic/blob/main/CHANGELOG.md)

Expand Down

0 comments on commit 20d290c

Please sign in to comment.