document

Author: 9sdk

README.md

@@ -7,3 +7,32 @@ Static files/assets used to spin up an Ultraviolet website.
 ## Install in [Ultraviolet-App](https://github.com/titaniumnetwork-dev/Ultraviolet-App.git)
 
 See [Ultraviolet-App's Wiki](https://github.com/titaniumnetwork-dev/Ultraviolet-App/wiki/Customizing-your-frontend).
+
+## Usage outside of Ultraviolet-App/Static hosting
+
+### Ultraviolet scripts
+
+This repository doesn't serve any Ultraviolet scripts. It has a `uv.config.js` to show how Ultraviolet is intended to work with this demo. Ultraviolet-App automatically merges our `uv.config.js` with the remaining UV scripts (`uv.sw.js`, `uv.client.js`, etc). **Some work has to be done in order to make this repository standalone.**
+
+Here's how to get the remaining scripts for the purpose of hosting this repository:
+
+1. Go to the [Ultraviolet releases](https://github.com/titaniumnetwork-dev/Ultraviolet/releases/)
+2. Find the latest release
+3. Download the latest tarball (eg. `titaniumnetwork-dev-ultraviolet-x.x.x.tgz`)
+4. Open the tarball, navigate to the `dist` directory, and extract all the scripts with the exception of `uv.config.js` (we already have a configuration) into the `public/uv/` directory in this repository.
+   You may see `.map` files. These are used for debugging. If they're too large, you can omit them without any errors.
+
+### Bare server
+
+You will need to point your Bare server to an external one/a different directory (if you're using reverse proxy software).
+
+1. Open `public/uv/config.js`
+2. Find the `bare` field
+3. Replace `"/bare/"` with the address of your Bare server
+   A Bare server address hosts the Bare server. For example, to use the Holy Unblocker Bare server at https://uv.holyubofficial.net/ you would update your config to look like this:
+
+   ```js
+       bare: "https://uv.holyubofficial.net/",
+   ```
+
+   You can open Bare server addresses in your browser. You should see something containing fields like the project description, memory usage, supported versions, and the runtime/language.