titaniumnet-mirror/ultraviolet
1
0
Fork 0
mirror of https://github.com/titaniumnetwork-dev/Ultraviolet.git synced 2025-05-15 20:40:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

link to docs

Browse source
This commit is contained in:
David Reed 2022-09-30 21:31:30 -04:00
parent e7f7d8854d
commit 898a6d21e1
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -8,6 +8,8 @@ Ultraviolet works by intercepting HTTP requests with a service worker script tha
See the [changelog](./CHANGELOG.md) if you're using v1.0.1 or above!
Documentation can be found on the [wiki](https://github.com/titaniumnetwork-development/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.
@ -35,16 +37,21 @@ $ npm install https://github.com/titaniumnetwork-development/Ultraviolet/release
## How do I build this?
1. Clone the repository
```sh
$ git clone https://github.com/titaniumnetwork-development/Ultraviolet.git
> Cloning into Ultraviolet...
$ cd Ultraviolet
```
2. Install dependencies
```sh
$ npm install
```
3. Produce the `dist/` directory and compile scripts
```sh
$ npm run build
```