From 898a6d21e1ab8d237bf6ef457fae64733cd5164d Mon Sep 17 00:00:00 2001 From: David Reed Date: Fri, 30 Sep 2022 21:31:30 -0400 Subject: [PATCH] link to docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 5a49991..7df3722 100644 --- a/README.md +++ b/README.md @@ -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 ```