RevelaNetwork/Revela
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

document

Browse source
This commit is contained in:
David Reed 2022-09-15 18:24:03 -04:00
parent c1b9d27642
commit 6a4215b1cb
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -10,12 +10,18 @@ See the [changelog](./CHANGELOG.md) if you're using v1.0.1 or above!
## How do I deploy/run this?
This repository is the bare-bones of Ultraviolet. This only contains the source code required to compile `uv.bundle.js`.
This repository is the bare-bones of Ultraviolet. This only contains the source code required to compile `uv.` scripts.
See [Ultraviolet-Node](https://github.com/titaniumnetwork-development/Ultraviolet-Node) for easy instructions to deploy an Ultraviolet website.
An example of REALLY using this (API, copying files, etc) is in [Ultraviolet-Static](https://github.com/titaniumnetwork-development/Ultraviolet-Static). See [scripts/build.js](https://github.com/titaniumnetwork-development/Ultraviolet-Static/blob/main/scripts/build.js).
## I don't care about building, where are the scripts for my website?!
You can extract the scripts from the NPM package in the [releases section](https://github.com/titaniumnetwork-development/Ultraviolet/releases). All the scripts you would typically look for (`uv.bundle.js`, `uv.handler.js`, `uv.sw.js`, and `uv.config.js`) are found within the `dist` directory.
If you cannot open the tar.gz (Chrome OS?), use a [converter](https://cloudconvert.com/tar.gz-to-zip). We can only do so much to make the scripts accessible.
## How do I package this?
```sh