diff --git a/README.md b/README.md index 01b7c7a..853cfd0 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -# Ultraviolet Frontend +# ultraviolet-scripts +Core Ultraviolet scripts + +# Configuration +Configure Ultraviolet for both client-hooking & service worker in `uv.config.js` +```javascript +self.__uv$config = { + bare: '/bare/', + prefix: '/service/', + encodeUrl: Ultraviolet.codec.xor.encode, + decodeUrl: Ultraviolet.codec.xor.decode, + handler: '/uv.handler.js', + bundle: '/uv.bundle.js', + config: '/uv.config.js', +}; +``` + + +# Example Usage +```javascript +importScripts('/PATHTOSCRIPTS/uv.sw.js'); + +const sw = new UVServiceWorker(); + +self.addEventListener('fetch', event => + event.respondWith( + sw.fetch(event) + ) +); +``` diff --git a/uv b/uv deleted file mode 160000 index 1684b5a..0000000 --- a/uv +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 1684b5a0fce91c78277dfa9a98a4f7d3aff66428