diff --git a/.gitignore b/.gitignore index 04c01ba..48a928d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ node_modules/ -dist/ \ No newline at end of file +dist/ +*.tgz \ No newline at end of file diff --git a/README.md b/README.md index bcaac7f..ef2157a 100644 --- a/README.md +++ b/README.md @@ -10,4 +10,28 @@ Ultraviolet works by intercepting HTTP requests with a service worker script tha This repository is the bare-bones of Ultraviolet. This only contains the source code required to compile `uv.bundle.js`. -See [Ultraviolet-Node](https://github.com/titaniumnetwork-development/Ultraviolet-Node) for easy instructions to deploy an Ultraviolet website. \ No newline at end of file +See [Ultraviolet-Node](https://github.com/titaniumnetwork-development/Ultraviolet-Node) for easy instructions to deploy an Ultraviolet website. + +## How do I package this? + +This is primarily for maintainers building then releasing on GitHub. We don't have an official NPM package. + +```sh +$ git clone https://github.com/titaniumnetwork-development/Ultraviolet.git +> Cloning into Ultraviolet... +$ cd Ultraviolet +``` + +```sh +$ npm install +``` + +```sh +$ npm run build +``` + +```sh +$ npm pack +``` + +Package will be named `ultraviolet-X.X.X.tgz` \ No newline at end of file diff --git a/package.json b/package.json index 0d16163..63b752c 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "ultraviolet", "version": "1.0.0", "description": "Proxy", + "main": "lib/index.js", "scripts": { "build": "cross-env NODE_ENV=production webpack-cli", "build:dev": "cross-env NODE_ENV=development webpack-cli", @@ -30,6 +31,7 @@ }, "files": [ "dist", - "src" + "src", + "lib" ] }