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

document

Browse source
This commit is contained in:
David Reed 2022-09-15 18:14:52 -04:00
parent 78c838bd9f
commit c1b9d27642
1 changed files with 14 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -6,7 +6,7 @@ Advanced web proxy used for evading internet censorship or accessing websites in
Ultraviolet works by intercepting HTTP requests with a service worker script that follows the [TompHTTP specifications](https://github.com/tomphttp).
See the [changelog](./CHANGELOG.md).
See the [changelog](./CHANGELOG.md) if you're using v1.0.1 or above!
## How do I deploy/run this?
@ -14,9 +14,9 @@ This repository is the bare-bones of Ultraviolet. This only contains the source
See [Ultraviolet-Node](https://github.com/titaniumnetwork-development/Ultraviolet-Node) for easy instructions to deploy an Ultraviolet website.
## How do I package this?
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).
This is primarily for maintainers building then releasing on GitHub. We don't have an official NPM package.
## How do I package this?
```sh
$ git clone https://github.com/titaniumnetwork-development/Ultraviolet.git
@ -36,4 +36,14 @@ $ npm run build
$ npm pack
```
Package will be named `ultraviolet-X.X.X.tgz`
Package will be named `ultraviolet-X.X.X.tgz`
## How do I install this?
> 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.
```sh
$ npm install https://github.com/titaniumnetwork-development/Ultraviolet/releases/download/v1.0.1/ultraviolet-1.0.1.tgz
```