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

Update org

Browse source
This commit is contained in:
David Reed 2022-11-14 23:21:21 -05:00
parent cd2f1c3c8f
commit d230e0e551
No known key found for this signature in database
GPG key ID: 2211691D8A1EE72F
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,4 +1,4 @@
<p align="center"><img src="https://raw.githubusercontent.com/titaniumnetwork-development/Ultraviolet-Static/main/public/uv.png" height="200"></p>
<p align="center"><img src="https://raw.githubusercontent.com/titaniumnetwork-dev/Ultraviolet-Static/main/public/uv.png" height="200"></p>
<h1 align="center">Ultraviolet</h1>
@ -10,19 +10,19 @@ See the [changelog](./CHANGELOG.md) if you're using v1.0.1 or above!
## Documentation
Documentation can be found in the [wiki](https://github.com/titaniumnetwork-development/Ultraviolet/wiki).
Documentation can be found in the [wiki](https://github.com/titaniumnetwork-dev/Ultraviolet/wiki).
## How do I deploy/run this?
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.
See [Ultraviolet-Node](https://github.com/titaniumnetwork-dev/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).
An example of REALLY using this (API, copying files, etc) is in [Ultraviolet-Static](https://github.com/titaniumnetwork-dev/Ultraviolet-Static). See [scripts/build.js](https://github.com/titaniumnetwork-dev/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.
You can extract the scripts from the NPM package in the [releases section](https://github.com/titaniumnetwork-dev/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.
@ -30,10 +30,10 @@ If you cannot open the tar.gz (Chrome OS?), use a [converter](https://cloudconve
> This will provide built files and the JS API to access the path of dist files.
Currently, we don't have an NPM package. As a current solution, you can install from a [GitHub release](https://github.com/titaniumnetwork-development/Ultraviolet/releases). Copy the link to the `.tgz` and install using NPM.
Currently, we don't have an NPM package. As a current solution, you can install from a [GitHub release](https://github.com/titaniumnetwork-dev/Ultraviolet/releases). Copy the link to the `.tgz` and install using NPM.
```sh
$ npm install https://github.com/titaniumnetwork-development/Ultraviolet/releases/download/v1.0.1/ultraviolet-1.0.1.tgz
$ npm install https://github.com/titaniumnetwork-dev/Ultraviolet/releases/download/v1.0.1/ultraviolet-1.0.1.tgz
```
## How do I build this?
@ -41,7 +41,7 @@ $ npm install https://github.com/titaniumnetwork-development/Ultraviolet/release
1. Clone the repository
```sh
$ git clone https://github.com/titaniumnetwork-development/Ultraviolet.git
$ git clone https://github.com/titaniumnetwork-dev/Ultraviolet.git
> Cloning into Ultraviolet...
$ cd Ultraviolet
```